diff --git a/docs/dyn/accesscontextmanager_v1.folders.html b/docs/dyn/accesscontextmanager_v1.folders.html index eb12836aa4..763c057a9a 100644 --- a/docs/dyn/accesscontextmanager_v1.folders.html +++ b/docs/dyn/accesscontextmanager_v1.folders.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

lookupConfiguredServicePerimeter(resource, x__xgafv=None)

-

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

+

Looks up the configured ServicePerimeter for a given resource.

Method Details

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

Method Details

lookupConfiguredServicePerimeter(resource, x__xgafv=None) -
Looks up the configured service perimeter for a given resource. Format: `['projects/{projectNumber}', 'folders/{folderNumber}']`.
+  
Looks up the configured ServicePerimeter for a given resource.
 
 Args:
-  resource: string, Required. The resource to resolve (for example, `projects/123` or `folders/456`). (required)
+  resource: string, Required. The resource name. Format: `projects/{project_number}` or `folders/{folder_number}` (for example, `projects/123` or `folders/456`) (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -100,11 +100,11 @@ 

Method Details

Returns: An object of the form: - { # A configured service perimeter returned by Access Context Manager. + { # A configured ServicePerimeter returned by Access Context Manager. "restrictedResource": "A String", # The resource (for example, `projects/123` or `folders/456`) that directly owns or is restricted by the enforced perimeter. "restrictedResourceDryRun": "A String", # The resource (for example, `projects/123` or `folders/456`) that directly owns or is restricted by the dry-run perimeter. - "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies. - "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no dry-run perimeter configuration applies. + "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. This field is empty if no enforced perimeter applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` + "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. This field is empty if no dry-run perimeter configuration applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` }
diff --git a/docs/dyn/accesscontextmanager_v1.projects.html b/docs/dyn/accesscontextmanager_v1.projects.html index bb347874af..e6d8971af2 100644 --- a/docs/dyn/accesscontextmanager_v1.projects.html +++ b/docs/dyn/accesscontextmanager_v1.projects.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

lookupConfiguredServicePerimeter(resource, x__xgafv=None)

-

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

+

Looks up the configured ServicePerimeter for a given resource.

Method Details

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

Method Details

lookupConfiguredServicePerimeter(resource, x__xgafv=None) -
Looks up the configured service perimeter for a given resource. Format: `['projects/{projectNumber}', 'folders/{folderNumber}']`.
+  
Looks up the configured ServicePerimeter for a given resource.
 
 Args:
-  resource: string, Required. The resource to resolve (for example, `projects/123` or `folders/456`). (required)
+  resource: string, Required. The resource name. Format: `projects/{project_number}` or `folders/{folder_number}` (for example, `projects/123` or `folders/456`) (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -100,11 +100,11 @@ 

Method Details

Returns: An object of the form: - { # A configured service perimeter returned by Access Context Manager. + { # A configured ServicePerimeter returned by Access Context Manager. "restrictedResource": "A String", # The resource (for example, `projects/123` or `folders/456`) that directly owns or is restricted by the enforced perimeter. "restrictedResourceDryRun": "A String", # The resource (for example, `projects/123` or `folders/456`) that directly owns or is restricted by the dry-run perimeter. - "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies. - "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no dry-run perimeter configuration applies. + "servicePerimeter": "A String", # Fully qualified name of the configured enforced perimeter. This field is empty if no enforced perimeter applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` + "servicePerimeterDryRun": "A String", # Fully qualified name of the configured dry-run perimeter. This field is empty if no dry-run perimeter configuration applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` }
diff --git a/docs/dyn/agentregistry_v1.projects.locations.skills.html b/docs/dyn/agentregistry_v1.projects.locations.skills.html index 9382935d89..c1449e2878 100644 --- a/docs/dyn/agentregistry_v1.projects.locations.skills.html +++ b/docs/dyn/agentregistry_v1.projects.locations.skills.html @@ -139,7 +139,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -153,7 +153,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -280,7 +280,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -294,7 +294,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -426,7 +426,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -440,7 +440,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -514,7 +514,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -528,7 +528,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -630,7 +630,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -644,7 +644,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. diff --git a/docs/dyn/agentregistry_v1.projects.locations.skills.revisions.html b/docs/dyn/agentregistry_v1.projects.locations.skills.revisions.html index 49532b4e84..732cd45dfb 100644 --- a/docs/dyn/agentregistry_v1.projects.locations.skills.revisions.html +++ b/docs/dyn/agentregistry_v1.projects.locations.skills.revisions.html @@ -116,7 +116,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -230,7 +230,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -300,7 +300,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html index acc5c21d55..764e3d4e2b 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.html @@ -139,7 +139,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -153,7 +153,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -280,7 +280,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -294,7 +294,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -426,7 +426,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -440,7 +440,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -514,7 +514,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -528,7 +528,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -630,7 +630,7 @@

Method Details

"description": "A String", # Optional. Brief summary describing the capabilities of the skill. Maximum length is 2048 characters. "displayName": "A String", # Optional. Human-readable display name of the skill. Maximum length is 128 characters. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Lightweight frontmatter metadata attributes copied from the default revision. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -644,7 +644,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. diff --git a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html index abe88cd61d..3c99a379ad 100644 --- a/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html +++ b/docs/dyn/agentregistry_v1alpha.projects.locations.skills.revisions.html @@ -116,7 +116,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -230,7 +230,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. @@ -300,7 +300,7 @@

Method Details

}, "createTime": "A String", # Output only. Revision creation timestamp. "frontmatter": { # Structured metadata attributes extracted from the package's local SKILL.md frontmatter. # Output only. Extracted YAML frontmatter configuration snapshot. - "compatibility": "A String", # Optional. Environmental dependencies or local sidecars. + "compatibility": "A String", # Optional. Environmental dependencies or companion services. "description": "A String", # Required. Functional description. "license": "A String", # Optional. License. "metadata": { # Optional. Extensible flattened map mapping custom tags, authors, and version parameters. diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index 8f67001cd0..26a46d235e 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -733,10 +733,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1433,10 +1433,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2472,10 +2472,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.interactions.html b/docs/dyn/aiplatform_v1.interactions.html index 2b7dd253c8..c2e64dacfc 100644 --- a/docs/dyn/aiplatform_v1.interactions.html +++ b/docs/dyn/aiplatform_v1.interactions.html @@ -377,6 +377,18 @@

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -1175,6 +1187,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -3310,6 +3502,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -5449,6 +5821,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -7563,6 +8115,90 @@

Method Details

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

Method Details

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

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html index c540db9707..bc481ec201 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html @@ -160,6 +160,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -173,9 +174,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -184,12 +185,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -315,6 +316,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -328,9 +330,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -339,12 +341,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -447,6 +449,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -460,9 +463,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -471,12 +474,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -550,6 +553,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -563,9 +567,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -574,12 +578,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "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 a58d048f15..0abb2a7e1f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -438,10 +438,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -905,10 +905,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1397,10 +1397,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1875,10 +1875,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2361,10 +2361,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2829,10 +2829,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 0466d6fd8c..167d03589e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -806,10 +806,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2402,10 +2402,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4923,10 +4923,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 067a4d62ac..fecabd3cbf 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -248,10 +248,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -489,10 +489,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -854,10 +854,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1095,10 +1095,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1459,10 +1459,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1700,10 +1700,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2215,10 +2215,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2456,10 +2456,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2821,10 +2821,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3062,10 +3062,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3426,10 +3426,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3667,10 +3667,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4173,10 +4173,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4414,10 +4414,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4779,10 +4779,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5020,10 +5020,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5384,10 +5384,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5625,10 +5625,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6140,10 +6140,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6381,10 +6381,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6746,10 +6746,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6987,10 +6987,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7351,10 +7351,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7592,10 +7592,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8140,10 +8140,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8381,10 +8381,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8746,10 +8746,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8987,10 +8987,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9351,10 +9351,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9592,10 +9592,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10107,10 +10107,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10348,10 +10348,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10713,10 +10713,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10954,10 +10954,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11318,10 +11318,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11559,10 +11559,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12078,10 +12078,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12319,10 +12319,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12684,10 +12684,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12925,10 +12925,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13289,10 +13289,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13530,10 +13530,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14045,10 +14045,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14286,10 +14286,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14651,10 +14651,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14892,10 +14892,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15256,10 +15256,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15497,10 +15497,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 2cfeeb8831..a7b387a481 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -2079,10 +2079,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4339,10 +4339,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6641,10 +6641,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8914,10 +8914,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html index 38231cacf3..4261db6857 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html @@ -238,10 +238,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -506,10 +506,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -816,10 +816,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1118,10 +1118,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1453,10 +1453,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1740,10 +1740,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2009,10 +2009,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index d079baa406..f8e664f56e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -519,10 +519,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -817,10 +817,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2760,10 +2760,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3107,10 +3107,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3544,10 +3544,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3785,10 +3785,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4135,10 +4135,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4376,10 +4376,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6930,10 +6930,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7548,10 +7548,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7789,10 +7789,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8154,10 +8154,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8395,10 +8395,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8759,10 +8759,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9000,10 +9000,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9755,10 +9755,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1.projects.locations.interactions.html index d1dd364e82..eccbf2b12e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.interactions.html @@ -380,6 +380,18 @@

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -1178,6 +1190,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -3302,57 +3494,141 @@

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # User provided metadata about the retrieved context. - "a_key": "", # Properties of the object. - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], "url": "A String", # URI reference of the place. @@ -3867,6 +4143,90 @@

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -5423,11 +5795,95 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -7561,6 +8113,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -9675,6 +10407,90 @@

Method Details

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

Method Details

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

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 3f84b73514..5d676d349e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -917,10 +917,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1786,10 +1786,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3053,10 +3053,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 07b29fef2d..f8b0e67d49 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -417,7 +417,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1426,10 +1426,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3040,10 +3040,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 7af0d519c5..6db392eb01 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -407,7 +407,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1575,10 +1575,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2012,10 +2012,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2253,10 +2253,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2603,10 +2603,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2844,10 +2844,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5397,10 +5397,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 08b813b382..b0defc6abb 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -187,6 +187,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -322,6 +323,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -592,6 +594,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -739,10 +742,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1004,6 +1007,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1288,6 +1292,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1451,10 +1456,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1670,6 +1675,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2056,6 +2062,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2340,6 +2347,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2503,10 +2511,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2722,6 +2730,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index d77f3af5b6..a25eabd781 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -384,6 +384,18 @@

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -1313,6 +1325,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -3884,6 +4076,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -6459,6 +6831,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -9008,6 +9560,90 @@

Method Details

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

Method Details

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

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.html index 63cb0bb9e0..cd302ecc5e 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.html @@ -171,6 +171,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html index 5328f8ffed..2655f4cea9 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html @@ -323,6 +323,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html index 759bdd2fc0..d3453cb5c3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agentAnomalyDetectionScopes.html @@ -108,16 +108,16 @@

Method Details

The object takes the form of: { # Represents an Agent Anomaly Detection Scope. - "autoEnroll": True or False, # Optional. When true, agents created in Agent Engine that share log and observability buckets with this scope are automatically enrolled as MonitoredAgents. When false, agents must be enrolled explicitly via MonitoredAgent operations. + "autoEnroll": True or False, # Optional. When `true`, newly discovered agents that share log and observability buckets with this scope are automatically enrolled as `ACTIVE` MonitoredAgents, up to the project's monitored agent quota. When `false`, newly discovered agents are added as `DISABLED` MonitoredAgents, and you must enable them explicitly through MonitoredAgent operations. "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Immutable. Specifies the customer-managed encryption key spec for a Scope. If set, this Scope and all sub-resources will be secured by this key. The key is immutable after the Scope is created and must be a multi-region (`us` or `eu`) key in the same region as the Scope. "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, - "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Specify exactly one bucket, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability datasets attached to this scope. Each value is the resource name of a dataset in an Observability bucket, such as the `Spans` dataset in the `_Trace` bucket. Specify exactly one dataset, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}/datasets/{dataset}`. "A String", ], "state": "A String", # Output only. The lifecycle state of the scope. @@ -203,16 +203,16 @@

Method Details

An object of the form: { # Represents an Agent Anomaly Detection Scope. - "autoEnroll": True or False, # Optional. When true, agents created in Agent Engine that share log and observability buckets with this scope are automatically enrolled as MonitoredAgents. When false, agents must be enrolled explicitly via MonitoredAgent operations. + "autoEnroll": True or False, # Optional. When `true`, newly discovered agents that share log and observability buckets with this scope are automatically enrolled as `ACTIVE` MonitoredAgents, up to the project's monitored agent quota. When `false`, newly discovered agents are added as `DISABLED` MonitoredAgents, and you must enable them explicitly through MonitoredAgent operations. "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Immutable. Specifies the customer-managed encryption key spec for a Scope. If set, this Scope and all sub-resources will be secured by this key. The key is immutable after the Scope is created and must be a multi-region (`us` or `eu`) key in the same region as the Scope. "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, - "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Specify exactly one bucket, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability datasets attached to this scope. Each value is the resource name of a dataset in an Observability bucket, such as the `Spans` dataset in the `_Trace` bucket. Specify exactly one dataset, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}/datasets/{dataset}`. "A String", ], "state": "A String", # Output only. The lifecycle state of the scope. @@ -238,16 +238,16 @@

Method Details

{ # Response message for AgentAnomalyDetectionService.ListAgentAnomalyDetectionScopes. "agentAnomalyDetectionScopes": [ # A list of AgentAnomalyDetectionScopes that matches the specified filter in the request. { # Represents an Agent Anomaly Detection Scope. - "autoEnroll": True or False, # Optional. When true, agents created in Agent Engine that share log and observability buckets with this scope are automatically enrolled as MonitoredAgents. When false, agents must be enrolled explicitly via MonitoredAgent operations. + "autoEnroll": True or False, # Optional. When `true`, newly discovered agents that share log and observability buckets with this scope are automatically enrolled as `ACTIVE` MonitoredAgents, up to the project's monitored agent quota. When `false`, newly discovered agents are added as `DISABLED` MonitoredAgents, and you must enable them explicitly through MonitoredAgent operations. "displayName": "A String", # Optional. User-provided display name of the AgentAnomalyDetectionScope. "encryptionSpec": { # Represents a customer-managed encryption key specification that can be applied to a Vertex AI resource. # Optional. Immutable. Specifies the customer-managed encryption key spec for a Scope. If set, this Scope and all sub-resources will be secured by this key. The key is immutable after the Scope is created and must be a multi-region (`us` or `eu`) key in the same region as the Scope. "kmsKeyName": "A String", # Required. Resource name of the Cloud KMS key used to protect the resource. The Cloud KMS key must be in the same region as the resource. It must have the format `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. }, - "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. + "logBuckets": [ # Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Specify exactly one bucket, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`. "A String", ], "name": "A String", # Identifier. The resource name of the AgentAnomalyDetectionScope. Format: `projects/{project}/locations/{location}/agentAnomalyDetectionScopes/{agent_anomaly_detection_scope}` - "observabilityBuckets": [ # Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`. + "observabilityBuckets": [ # Required. Customer-owned Cloud Observability datasets attached to this scope. Each value is the resource name of a dataset in an Observability bucket, such as the `Spans` dataset in the `_Trace` bucket. Specify exactly one dataset, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}/datasets/{dataset}`. "A String", ], "state": "A String", # Output only. The lifecycle state of the scope. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html index f025b247e1..cb681eb903 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html @@ -170,6 +170,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -183,9 +184,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -194,12 +195,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -325,6 +326,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -338,9 +340,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -349,12 +351,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -457,6 +459,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -470,9 +473,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -481,12 +484,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -560,6 +563,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the agent. Format: `projects/{project}/locations/{location}/agents/{agent}`. "object": "A String", # Output only. The object type of the resource. For agents, the value is `agent`. "observabilityConfig": { # Observability settings for one agent's sessions. # Optional. Observability settings for this agent's sessions. + "artifactGcsBucket": "A String", # Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted. "observabilityEnabled": True or False, # Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored. "sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (prompts, model completions, tool argument payloads and tool responses). If `false`, those are sanitized and only structural attributes are recorded. No effect unless `observability_enabled` is true. Settable and returned, but NOT YET ENFORCED. Nothing reads it at runtime, so `true` does not currently cause content to be captured, and `false` is not what keeps content from being captured. Treat it as a recorded intention that takes effect when enforcement lands. }, @@ -573,9 +577,9 @@

Method Details

"personality": "A String", # Optional. The personality style or behavioral trait of the agent. "role": "A String", # Optional. The role of the agent (e.g., "Financial Analyst"). }, - "status": { # Operational state of the agent. # Output only. The current operational state of the agent. + "status": { # Operational state of the agent. # Optional. The current operational state of the agent. "deleteTime": "A String", # Output only. The time at which the agent was soft-deleted. - "state": "A String", # Output only. The current state of the agent. + "state": "A String", # Optional. The current state of the agent. "suspensionReason": { # Details about the active suspension. This message is only populated if the state is SUSPENDED. # Output only. Context about the current active suspension. "reason": "A String", # Output only. The reason for the current suspension. "suspensionTime": "A String", # Output only. The time when the current suspension was applied. @@ -584,12 +588,12 @@

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. 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`. + "headers": { # Optional. Not used; the tool is resolved from `name` via Agent Registry. "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: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` - "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. + "type": "A String", # Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation` + "url": "A String", # Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required. }, ], "updated": "A String", # Output only. The time the agent was last updated. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.artifacts.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.artifacts.html index 685d37b084..3b75dbc9e2 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.artifacts.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.artifacts.html @@ -86,6 +86,9 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Moves a file, including a `.link.json` link, from `path` in a task's workspace to `destination_path` in `destination_parent`'s workspace.

preview(parent, outputMimeType=None, path=None, x__xgafv=None)

Returns a file converted for a preview, such as a PDF of a .pptx. A server-streaming RPC. The response body is the converted file's bytes, with its media type as the `Content-Type`. The server converts the file as it is stored now, on every call, and stores nothing. A PDF asked for as a PDF is returned as stored. Fails with `INVALID_ARGUMENT` or `FAILED_PRECONDITION` when the file cannot be converted (an unsupported format, too large, or unreadable), with `DEADLINE_EXCEEDED` when the conversion takes too long, and with `UNAVAILABLE` when conversion is busy or not available; the last two may succeed on a retry.

@@ -110,6 +113,7 @@

Method Details

"path": "A String", # Output only. Absolute path of the link file in the workspace, e.g. `/workspace/userdata/{artifact_id}.link.json` in a task or `/workspace/project/{artifact_id}.link.json` in a collaborative project. Always under `/workspace` and never contains `..`. Set by `ArtifactService.ListWorkspaceArtifacts`. `ArtifactService.AddArtifact` clears it from a request, so it is never written to the link file. "provider": "A String", # Required. The store that holds the entity. "sourceArtifactId": "A String", # Optional. The entity's ID in its store, unique within `provider`: a Drive file ID, a Jira issue ID, or, for OneDrive and SharePoint, whose item IDs are unique only within a drive, the drive ID and the drive item ID, e.g. "{drive-id}/{item-id}". At most 1024 characters. With `provider`, it identifies the entity: it names the link file and is the idempotency key for `AddArtifact`. When it is unset, `uri` takes its place, so two URIs of one entity, such as a Drive file's /view and /edit URIs, are two entities. + "title": "A String", # Optional. The entity's title in its store, e.g. a GitHub issue's title, an email's subject or a file's name. At most 1024 characters. "updateTime": "A String", # Output only. Last modification time of the link file at `path`, as `ArtifactService.ListWorkspaceArtifacts` read it. Not part of a link file. It is what tells two listings of one entity apart after the entity was updated in place. Such an update leaves every other field alone -- the entity keeps its `uri` and its `source_artifact_id`, so the link file keeps its name -- and it leaves the link file's bytes alone too, because a link file records WHICH entity is linked and not what state that entity is in. The time the file was rewritten is the only thing that moves. "uri": "A String", # Required. URI of the entity, e.g. "https://drive.google.com/file/d/FILE_ID/view". At most 2048 characters. }, @@ -163,12 +167,13 @@

Method Details

"path": "A String", # Output only. Absolute path of the link file in the workspace, e.g. `/workspace/userdata/{artifact_id}.link.json` in a task or `/workspace/project/{artifact_id}.link.json` in a collaborative project. Always under `/workspace` and never contains `..`. Set by `ArtifactService.ListWorkspaceArtifacts`. `ArtifactService.AddArtifact` clears it from a request, so it is never written to the link file. "provider": "A String", # Required. The store that holds the entity. "sourceArtifactId": "A String", # Optional. The entity's ID in its store, unique within `provider`: a Drive file ID, a Jira issue ID, or, for OneDrive and SharePoint, whose item IDs are unique only within a drive, the drive ID and the drive item ID, e.g. "{drive-id}/{item-id}". At most 1024 characters. With `provider`, it identifies the entity: it names the link file and is the idempotency key for `AddArtifact`. When it is unset, `uri` takes its place, so two URIs of one entity, such as a Drive file's /view and /edit URIs, are two entities. + "title": "A String", # Optional. The entity's title in its store, e.g. a GitHub issue's title, an email's subject or a file's name. At most 1024 characters. "updateTime": "A String", # Output only. Last modification time of the link file at `path`, as `ArtifactService.ListWorkspaceArtifacts` read it. Not part of a link file. It is what tells two listings of one entity apart after the entity was updated in place. Such an update leaves every other field alone -- the entity keeps its `uri` and its `source_artifact_id`, so the link file keeps its name -- and it leaves the link file's bytes alone too, because a link file records WHICH entity is linked and not what state that entity is in. The time the file was rewritten is the only thing that moves. "uri": "A String", # Required. URI of the entity, e.g. "https://drive.google.com/file/d/FILE_ID/view". At most 2048 characters. }, "taskArtifactFile": { # A file or directory in a task's workspace. # A file or directory in the workspace. "mimeType": "A String", # Output only. The detected media type. Empty for directories. - "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to DownloadTaskArtifact. + "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to ArtifactService.DownloadArtifact. "sizeBytes": "A String", # Output only. Size of the file in bytes. Zero for directories. "type": "A String", # Output only. Whether this entry is a file or a directory. "updateTime": "A String", # Output only. Last modification time of the file as it was read: the sandbox's when read from a running sandbox, otherwise the stored object's. @@ -192,6 +197,33 @@

Method Details

+
+ move(parent, body=None, x__xgafv=None) +
Moves a file, including a `.link.json` link, from `path` in a task's workspace to `destination_path` in `destination_parent`'s workspace.
+
+Args:
+  parent: string, Required. The task whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for ArtifactService.MoveArtifact.
+  "destinationParent": "A String", # Required. The task or collaborative project to move the file into, in the same project and location as `parent`. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}
+  "destinationPath": "A String", # Required. Absolute path for the file in `destination_parent`'s workspace: under `/workspace/project/` for a collaborative project, and not under it for a task. Fails with `ALREADY_EXISTS` if a file is already there.
+  "path": "A String", # Required. Absolute path of the file in the task's workspace, e.g. `/workspace/deliverables/report.md`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for ArtifactService.MoveArtifact.
+}
+
+
preview(parent, outputMimeType=None, path=None, x__xgafv=None)
Returns a file converted for a preview, such as a PDF of a .pptx. A server-streaming RPC. The response body is the converted file's bytes, with its media type as the `Content-Type`. The server converts the file as it is stored now, on every call, and stores nothing. A PDF asked for as a PDF is returned as stored. Fails with `INVALID_ARGUMENT` or `FAILED_PRECONDITION` when the file cannot be converted (an unsupported format, too large, or unreadable), with `DEADLINE_EXCEEDED` when the conversion takes too long, and with `UNAVAILABLE` when conversion is busy or not available; the last two may succeed on a retry.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.html
index 23dd145d96..06e4a14fd4 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.tasks.html
@@ -99,7 +99,7 @@ 

Instance Methods

Downloads a file. The response body is the file's bytes, with the file's own media type as the `Content-Type` and a `Content-Disposition` that names the file. Media is the default and only representation, so no `alt` parameter is needed. A preview sets `processing_config` and gets a rendition of the file in place of the file, such as a PDF of a .pptx: the response body is the rendition, with its own media type as the `Content-Type` and a `Content-Disposition` name that ends in its extension. Without `processing_config` the response is always the stored file.

downloadArtifact(task, path=None, processingConfig_outputMimeType=None, x__xgafv=None)

-

Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.

+

Deprecated: use `ArtifactService.DownloadArtifact` instead. Pass this request's `task` as its `name`, the same `path`, and, for a preview, the same `processing_config.output_mime_type`; the file is served as media through Scotty rather than streamed through this service, without this method's 1 GiB cap. `ArtifactService.PreviewArtifact` also returns a converted file as a stream. This method keeps working unchanged while callers migrate. Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.

download_media(name, path=None, processingConfig_outputMimeType=None, x__xgafv=None)

Downloads a file. The response body is the file's bytes, with the file's own media type as the `Content-Type` and a `Content-Disposition` that names the file. Media is the default and only representation, so no `alt` parameter is needed. A preview sets `processing_config` and gets a rendition of the file in place of the file, such as a PDF of a .pptx: the response body is the rendition, with its own media type as the `Content-Type` and a `Content-Disposition` name that ends in its extension. Without `processing_config` the response is always the stored file.

@@ -115,6 +115,12 @@

Instance Methods

listArtifacts_next(previous_request, previous_response)

Retrieves the next page of results.

+

+ listEvents(task, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists a task's execution events -- trajectory steps, status changes, and task detail and artifact updates -- one page at a time. The unary counterpart of StreamTask with `snapshot` set: it reads the same stored events, in the same order and with the same content, and returns them in pages instead of on a stream, for callers that cannot hold a stream open. Like StreamTask, it reads the task's trajectory from interaction storage and never restores the runtime actor. Unlike StreamTask, it never waits: a task that has not started running yet returns no events. Storage can trail the live stream by a few seconds, so the newest events a participant sees on CreateTaskBidiStream may not be listed yet.

+

+ listEvents_next(previous_request, previous_response)

+

Retrieves the next page of results.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -135,7 +141,7 @@

Instance Methods

Uploads a file. The file is sent as media: post it to this method's URL with an `/upload` prefix, e.g. `/upload/v1beta1/{name}:upload`, carrying `path` as request metadata and the file's bytes as the media content. The task must not be in a terminal state, and an existing file at `path` is replaced. At most 10 GiB.

uploadArtifact(task, body=None, path=None, x__xgafv=None)

-

Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.

+

Deprecated: use `ArtifactService.UploadArtifact` instead. Pass this request's `task` as its `name` and the same `path`, and send the file as media to `POST /upload/v1beta1/{name}:upload`. UploadArtifact stores the file through Scotty, takes files up to 10 GiB, and returns the stored `path`; `ArtifactService.ListWorkspaceArtifacts` returns the rest of the file's `TaskArtifactFile`. This method keeps working unchanged while callers migrate. Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.

Method Details

cancel(name, body=None, x__xgafv=None) @@ -446,7 +452,7 @@

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -878,6 +884,90 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -2102,6 +2192,90 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -3327,6 +3501,90 @@

Method Details

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

Method Details

downloadArtifact(task, path=None, processingConfig_outputMimeType=None, x__xgafv=None) -
Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.
+  
Deprecated: use `ArtifactService.DownloadArtifact` instead. Pass this request's `task` as its `name`, the same `path`, and, for a preview, the same `processing_config.output_mime_type`; the file is served as media through Scotty rather than streamed through this service, without this method's 1 GiB cap. `ArtifactService.PreviewArtifact` also returns a converted file as a stream. This method keeps working unchanged while callers migrate. Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.
 
 Args:
   task: string, Required. The task to download from. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
@@ -4489,7 +4747,7 @@ 

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -4921,10 +5179,94 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -6152,6 +6494,90 @@

Method Details

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

Method Details

"mountPath": "A String", # Optional. Absolute path in the environment where the directory is mounted. Empty means `/workspace/desktop`. When set, must be `/workspace/{name}`, where `{name}` is 1-63 lowercase letters, digits, `_` or `-`, starts with a letter or digit, and is not one of the names other mounts own under `/workspace`: `skills`, `core`, `memory`, `inputs`, `artifacts`, `deliverables` or `userdata`. "sourcePath": "A String", # Optional. Absolute path of the folder on the connecting client (the mount source). Interpreted only by the client; the server never resolves it. }, - "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # Optional. Optional client-side ("local") environment: the agent's built-in filesystem/shell operations are yielded to the connecting client (e.g. the gogo desktop client) to execute locally, instead of running in a server-managed sandbox. Mirrors Interaction.local_environment and is mutually exclusive with `environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + "localEnvironment": { # Configuration for an environment that lives on the client connection rather than in a server-managed sandbox. When set (via Interaction.local_environment), the agent's filesystem and shell are treated as living on the client: the agent's built-in environment operations (e.g. reading/listing/editing files and running commands) are suspended on the server and yielded back to the client to execute, with their results returned on a subsequent turn. This is mutually exclusive with a server-managed `EnvironmentConfig` (remote_environment), since the environment is either on the client or in a server sandbox, never both. This governs only the agent's built-in environment. Client-declared function tools are always executed on the client regardless of this field. # Optional. Optional client-side ("local") environment: the agent's built-in filesystem/shell operations are yielded to the connecting client (e.g. the gogo desktop client) to execute locally, instead of running in a server-managed sandbox. Mirrors Interaction.local_environment and is mutually exclusive with `environment`. (Independent of any client-declared function tools, which are always executed on the client regardless of this field.) + }, + "memoryConfig": { # Task-level memory settings: which sources memory draws from, and whether memory is active for this task at all. # Optional. Memory settings for this task. + "disableMemory": True or False, # Optional. If true, the agent neither reads existing memories into the prompt nor forms new ones from this task. Memory is on by default, and this can only turn it off, never back on: * Agent memory enabled, this true: off for this task. * Agent memory enabled, this false or unset: on. * Agent memory disabled: off, whatever this says. Because a task belongs to a single end user's interaction, a surface that knows the user can use this to turn memory off for one user of a shared agent; memory keeps working for the agent's other users. `Agent.memory_config.disable_memory` wins because it is the mutable one. It can be turned on after tasks have already been created, and a stored task spec keeps whatever it was created with — so if a spec could re-enable memory, the agent-level switch would be unable to cover the tasks that already exist. The two are therefore OR'ed, and the agent's current value is re-applied every time a session opens, including on a resume. Scoped to this task. Memories already stored for the agent are retained and stay readable by the agent's users; this governs only whether this task can access and modify them. + "knowledgeCatalogConfig": { # Configuration for enterprise Knowledge Catalog metadata discovery. # Optional. Configuration for enterprise Knowledge Catalog search. + "enabledConnectors": [ # Optional. Filter list of system/connector technology names (e.g., "bigquery", "looker", "spanner"). If empty, all indexed catalog connectors are searched. + "A String", + ], + "knowledgeCatalogEnabled": True or False, # Optional. If true, enables searching enterprise metadata in Google Cloud Knowledge Catalog. + "projectId": "A String", # Optional. GCP project ID to scope Knowledge Catalog searches. + }, + }, + }, + "subtaskConfig": { # Configuration and limits for subtasks spawned by this task. # Optional. Configuration and limits for subtasks spawned by this task. + "maxDepth": 42, # Optional. The maximum depth of subtask hierarchy allowed under this task. Must be between 0 and 5, inclusive. When unset on a root task, defaults to 5. For a subtask, it is clamped to at most parent.max_depth - 1 (defaulting to parent.max_depth - 1 if unspecified). A value of 0 means this task cannot spawn any subtasks. + }, + "systemInstruction": "A String", # Optional. Optional standing instruction applied across the whole task. + }, + "status": "A String", # Output only. The coarse, durable status of the task. + "statusDetail": { # Why a task is in its current status, when the status alone is not enough to act on (today: `SUSPENDED`). Clients MUST treat an unrecognized `StatusReason` as an opaque block. Copied to the DB mirror by name and number, so a field or enum value added here without the matching DB-side addition is silently dropped on write. LINT.IfChange(status_detail) # Output only. Explanation for the current state, when the state alone is not enough to act on (today: `SUSPENDED`). Cleared when the task leaves that state. + "detail": "A String", # Optional human-readable explanation, so a surface can render something without its own StatusReason -> string table. Not localized; clients needing localization should render from `reason` instead. Not a `google.rpc.Status`: RPC codes do not map onto lifecycle states, and `TaskOutcome.status` already covers terminal failures. + "reason": "A String", # Machine-readable reason. Clients switch on this to pick a recovery affordance (upsell CTA, admin contact, retry). + }, + "statusUpdateTime": "A String", # Output only. The time the task's status was last updated. + "summary": "A String", # Output only. A rolling, system-generated summary of the task's progress/result. + "title": "A String", # Optional. Optional human-readable title for listing surfaces. + "updateTime": "A String", # Output only. The time the task was last updated. + }, + ], +}
+
+ +
+ listArtifacts(task, pageSize=None, pageToken=None, path=None, recursive=None, x__xgafv=None) +
Lists the files in a task's workspace. By default only the immediate children of `path` are returned; set `recursive` to descend into subdirectories. Entries are returned in breadth-first order. While the task's sandbox is running, paths it writes locally are read from the sandbox so the listing reflects files not yet synced to storage; otherwise they are read from storage. Which one served a request is not visible to the caller.
+
+Args:
+  task: string, Required. The task whose workspace to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
+  pageSize: integer, Optional. The maximum number of entries to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.
+  pageToken: string, Optional. A page token from a previous ListTaskArtifacts call. The workspace is live: the agent can write between pages, so a paged listing is not a snapshot. An entry added during the walk may or may not appear, and one removed may still be listed and then fail to download.
+  path: string, Optional. Absolute path of the directory to list, e.g. "/workspace/userdata". Must be "/workspace" or under it, at most 1024 characters, and not contain a ".." segment. Defaults to "/workspace".
+  recursive: boolean, Optional. If true, descends into subdirectories. Results are breadth-first.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TaskService.ListTaskArtifacts.
+  "artifacts": [ # The entries under the requested directory.
+    { # A file or directory in a task's workspace.
+      "mimeType": "A String", # Output only. The detected media type. Empty for directories.
+      "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to ArtifactService.DownloadArtifact.
+      "sizeBytes": "A String", # Output only. Size of the file in bytes. Zero for directories.
+      "type": "A String", # Output only. Whether this entry is a file or a directory.
+      "updateTime": "A String", # Output only. Last modification time of the file as it was read: the sandbox's when read from a running sandbox, otherwise the stored object's.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page; empty if there are no more pages.
+}
+
+ +
+ listArtifacts_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.
+
+
+ +
+ listEvents(task, pageSize=None, pageToken=None, x__xgafv=None) +
Lists a task's execution events -- trajectory steps, status changes, and task detail and artifact updates -- one page at a time. The unary counterpart of StreamTask with `snapshot` set: it reads the same stored events, in the same order and with the same content, and returns them in pages instead of on a stream, for callers that cannot hold a stream open. Like StreamTask, it reads the task's trajectory from interaction storage and never restores the runtime actor. Unlike StreamTask, it never waits: a task that has not started running yet returns no events. Storage can trail the live stream by a few seconds, so the newest events a participant sees on CreateTaskBidiStream may not be listed yet.
+
+Args:
+  task: string, Required. The task whose events to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
+  pageSize: integer, Optional. The maximum number of events to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.
+  pageToken: string, Optional. A page token from a previous ListTaskEvents call. Listing continues immediately after the last event of that page. Following `next_page_token` from page to page never skips or repeats an event. This token is the same token that the StreamTask API uses and hence could be used interchangeably. Opaque: pass it back unchanged and send it only to the task it was issued for. A token this call cannot redeem is rejected with INVALID_ARGUMENT rather than listing from the start. When paginating, all other parameters except `page_size` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for TaskService.ListTaskEvents.
+  "assignedAgentIdentity": "A String", # The resolved Agent Identity (SPIFFE ID) of the `Agent` this task is assigned to, as StreamTask reports on its first message.
+  "events": [ # The task's events, in the order they were delivered: the same events, with the same `seq_num`, that StreamTask returns with `snapshot` set. Each event also carries a `continuation_token` wherever StreamTask issues one. A page carries a `status_changed` event only where the status changed, so the status in effect when the page starts is not repeated on it; read the current status with GetTask.
+    { # A single Server -> Client event. There is intentionally no non-terminal error/notice branch. Transient, retriable failures (tool-fetch retry, rate-limit, scheduler retry) are handled by runtime retry (bounded by TaskSpec.max_retries) and, if surfaced at all, appear as trajectory steps; the terminal error is reported once via TaskCompletedEvent.outcome.status (google.rpc.Status). This follows the Interactions events.proto, which deprecated its dedicated non-terminal InteractionPausedEvent and reports terminal status on InteractionCompletedEvent.
+      "continuationToken": "A String", # Optional. Opaque resume cursor covering everything delivered through this event, inclusive. A client that keeps the token from the last event it processed and passes it back on SubscribeTaskEvent.continuation_token or StreamTaskRequest.continuation_token resumes at the next event, with no gap and no duplicate. Opaque: the encoding is a server implementation detail and may change without notice. Do not parse it, compare two of them, or derive ordering from it -- order by `seq_num`. Carries no task id, because every RPC that redeems a token already names the task it applies to. It is a position, not a capability: it grants no access on its own, and the task's IAM check is what authorizes the read. This is the resume cursor. Resuming by number (next_step_seq_num on SubscribeTaskEvent and StreamTaskRequest) is slated for deprecation: a number cannot address a position inside a streamed step, while the token can, so a reconnect mid-answer does not re-send the part of that answer the client already rendered. `seq_num` remains for ordering only.
+      "eventId": "A String", # Optional. The TaskClientEvent.event_id this event was derived from, echoed back verbatim. Set only on the events that carry a client input back out: the `step` echoing the input, and the `step_start` of a streamed step the input opened. Empty everywhere else -- on model-generated steps the server produced on its own, on the step_delta/step_stop frames continuing a run (correlate those by `index` with their step_start), and on any event whose client input carried no event_id. Purely a correlation handle: it does not order or acknowledge anything, and the server never derives behavior from it. Since the server does not enforce uniqueness, a client that reuses an id sees it on every echo it produced. Delivered to every client subscribed to the task, not just the one that sent the input, including on a later replay from storage.
+      "seqNum": "A String", # Required. 1-based, non-decreasing sequence number within the server direction, stable across reconnects, so it can be used to resume: a given event carries the same number however the stream is (re)connected. Gapless on a stream delivered from the beginning. Clients acknowledge receipt via ack_output_seq_num and resume via SubscribeTaskEvent.next_step_seq_num. A resume with next_step_seq_num = 0 (or unset) restarts from the first still available step. A number identifies a resume point, not an event, so it is not unique: consecutive events can share one. An event derived from another (an artifacts_changed delta carrying the plan its step just wrote) repeats its source's number rather than taking the next, which keeps the numbering a function of the stream alone and guarantees a cursor never lands between the two. Acknowledging a number acknowledges every event carrying it. A resume can begin AFTER the requested number. next_step_seq_num counts events, but a streamed step spans several of them, so a cursor can point inside a run; the server then suppresses that run's remaining step_delta/step_stop rather than deliver frames for a step the client never saw opened, and resumes at the next step boundary. Numbering is unchanged by that suppression -- keeping it stable is what makes a cursor meaningful across connections -- so the first delivered event may be a later number than asked for. Treat the sequence as monotonic, not densely contiguous, when resuming.
+      "statusChanged": { # Signals a task status transition. # A coarse status transition (e.g. WORKING -> REQUIRES_ACTION when the task is waiting on a human response).
+        "statusDetail": { # Why a task is in its current status, when the status alone is not enough to act on (today: `SUSPENDED`). Clients MUST treat an unrecognized `StatusReason` as an opaque block. Copied to the DB mirror by name and number, so a field or enum value added here without the matching DB-side addition is silently dropped on write. LINT.IfChange(status_detail) # Machine-readable reason and details for why the task entered this status (e.g. `SUSPENDED`).
+          "detail": "A String", # Optional human-readable explanation, so a surface can render something without its own StatusReason -> string table. Not localized; clients needing localization should render from `reason` instead. Not a `google.rpc.Status`: RPC codes do not map onto lifecycle states, and `TaskOutcome.status` already covers terminal failures.
+          "reason": "A String", # Machine-readable reason. Clients switch on this to pick a recovery affordance (upsell CTA, admin contact, retry).
+        },
+        "taskStatus": "A String", # The new coarse task status.
+      },
+      "step": { # A step in the interaction. # A trajectory output step (thought, tool call, content, elicitation_call, etc.). Human-in-the-loop requests are just steps: the server emits an ElicitationCallStep (for an approval / choice) or a ToolCallStep (for a client-executed tool), and the client responds with the matching ElicitationResultStep / ToolResultStep, correlated by elicitation_id / call_id. The kind of action required is inferred from the step's type, so there is no separate "action required" event.
+        "modelOutput": { # Output generated by the model.
+          "content": [
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": { # User provided metadata about the retrieved context.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                      "speaker": "A String", # The speaker to associate with this turn.
+                      "style": "A String", # Style instruction for the speech synthesis.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                      "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "text": "A String", # The transcribed word.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                "processingConfig": {
+                  "static": {
+                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                    "fps": 3.14, # Optional. Video frame-rate sampling density.
+                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                  },
+                },
+                "processingType": "A String",
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+          "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+        },
+        "thought": { # A thought step.
+          "signature": "A String", # A signature hash for backend validation.
+          "summary": [ # A summary of the thought.
+            { # The content of the response.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": { # User provided metadata about the retrieved context.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                      "speaker": "A String", # The speaker to associate with this turn.
+                      "style": "A String", # Style instruction for the speech synthesis.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                      "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "text": "A String", # The transcribed word.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                "processingConfig": {
+                  "static": {
+                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                    "fps": 3.14, # Optional. Video frame-rate sampling density.
+                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                  },
+                },
+                "processingType": "A String",
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          ],
+        },
+        "toolCall": { # Tool call step.
+          "codeExecutionCall": { # Code execution call step.
+            "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+              "code": "A String", # The code to be executed.
+              "language": "A String", # Programming language of the `code`.
+            },
+          },
+          "fileSearchCall": { # File Search call step.
+          },
+          "functionCall": { # A function tool call step.
+            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": { # User provided metadata about the retrieved context.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                              "speaker": "A String", # The speaker to associate with this turn.
+                              "style": "A String", # Style instruction for the speech synthesis.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                              "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                              "text": "A String", # The transcribed word.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                        "processingConfig": {
+                          "static": {
+                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                            "fps": 3.14, # Optional. Video frame-rate sampling density.
+                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                          },
+                        },
+                        "processingType": "A String",
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiValue
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Required. The name of the tool to call.
+          },
+          "googleMapsCall": { # Google Maps call step.
+            "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+              "queries": [ # The queries to be executed.
+                "A String",
+              ],
+            },
+          },
+          "googleSearchCall": { # Google Search call step.
+            "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+              "queries": [ # Web search queries for the following-up web search.
+                "A String",
+              ],
+            },
+            "searchType": "A String", # The type of search grounding enabled.
+          },
+          "id": "A String", # Required. A unique ID for this specific tool call.
+          "mcpServerToolCall": { # MCPServer tool call step.
+            "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
+              "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                { # Represents a single field in a struct.
+                  "name": "A String",
+                  "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                    "boolValue": True or False, # Represents a boolean value.
+                    "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                      "audio": { # An audio content block.
+                        "channels": 42, # The number of audio channels.
+                        "data": "A String", # The audio content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "sampleRate": 42, # The sample rate of the audio.
+                        "uri": "A String", # The URI of the audio.
+                      },
+                      "document": { # A document content block.
+                        "data": "A String", # The document content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "uri": "A String", # The URI of the document.
+                      },
+                      "image": { # An image content block.
+                        "data": "A String", # The image content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the image.
+                      },
+                      "text": { # A text content block.
+                        "annotations": [ # Citation information for model-generated content.
+                          { # Citation information for model-generated content.
+                            "endIndex": 42, # End of the attributed segment, exclusive.
+                            "fileCitation": { # A file citation annotation. # A file citation annotation.
+                              "customMetadata": { # User provided metadata about the retrieved context.
+                                "a_key": "", # Properties of the object.
+                              },
+                              "documentUri": "A String", # The URI of the file.
+                              "fileName": "A String", # The name of the file.
+                              "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                              "pageNumber": 42, # Page number of the cited document, if applicable.
+                              "source": "A String", # Source attributed for a portion of the text.
+                            },
+                            "placeCitation": { # A place citation annotation. # A place citation annotation.
+                              "name": "A String", # Title of the place.
+                              "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                              "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                  "reviewId": "A String", # The ID of the review snippet.
+                                  "title": "A String", # Title of the review.
+                                  "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                },
+                              ],
+                              "url": "A String", # URI reference of the place.
+                            },
+                            "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                              "speaker": "A String", # The speaker to associate with this turn.
+                              "style": "A String", # Style instruction for the speech synthesis.
+                            },
+                            "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                            "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                              "title": "A String", # The title of the URL.
+                              "url": "A String", # The URL.
+                            },
+                            "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                              "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                              "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                              "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                              "text": "A String", # The transcribed word.
+                            },
+                          },
+                        ],
+                        "text": "A String", # Required. The text content.
+                      },
+                      "video": { # A video content block.
+                        "data": "A String", # The video content.
+                        "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                        "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                        "processingConfig": {
+                          "static": {
+                            "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                            "fps": 3.14, # Optional. Video frame-rate sampling density.
+                            "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                          },
+                        },
+                        "processingType": "A String",
+                        "resolution": "A String", # The resolution of the media.
+                        "uri": "A String", # The URI of the video.
+                      },
+                    },
+                    "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                      "values": [ # Repeated field of dynamically typed values.
+                        # Object with schema name: GenaiValue
+                      ],
+                    },
+                    "nullValue": "A String", # Represents a null value.
+                    "numberValue": 3.14, # Represents a double value.
+                    "stringValue": "A String", # Represents a string value.
+                    "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+                  },
+                },
+              ],
+            },
+            "name": "A String", # Required. The name of the tool which was called.
+            "serverName": "A String", # Required. The name of the used MCP server.
+          },
+          "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
+          },
+          "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
+            "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
+              "queries": [ # Queries for Retrieval information.
+                "A String",
+              ],
+            },
+            "retrievalType": "A String", # The type of retrieval tools.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextCall": { # URL context call step.
+            "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+              "urls": [ # The URLs to fetch.
+                "A String",
+              ],
+            },
+          },
+        },
+        "toolResult": { # Tool result step.
+          "callId": "A String", # Required. ID to match the ID from the function call block.
+          "codeExecutionResult": { # Code execution result step.
+            "content": { # A list of Content. # Multimodal output of the code execution.
+              "contents": [ # The contents of the list.
+                { # The content of the response.
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": { # User provided metadata about the retrieved context.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                          "speaker": "A String", # The speaker to associate with this turn.
+                          "style": "A String", # Style instruction for the speech synthesis.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                          "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "text": "A String", # The transcribed word.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                    "processingConfig": {
+                      "static": {
+                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                        "fps": 3.14, # Optional. Video frame-rate sampling density.
+                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                      },
+                    },
+                    "processingType": "A String",
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+              ],
+            },
+            "isError": True or False, # Whether the code execution resulted in an error.
+            "result": "A String", # Required. The output of the code execution.
+          },
+          "fileSearchResult": { # File Search result step.
+          },
+          "functionResult": { # Result of a function tool call.
+            "isError": True or False, # Whether the tool call resulted in an error.
+            "name": "A String", # The name of the tool that was called.
+            "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiValue
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+            },
+          },
+          "googleMapsResult": { # Google Maps result step.
+            "result": [
+              { # The result of the Google Maps.
+                "places": [
+                  {
+                    "name": "A String",
+                    "placeId": "A String",
+                    "reviewSnippets": [
+                      { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                        "reviewId": "A String", # The ID of the review snippet.
+                        "title": "A String", # Title of the review.
+                        "url": "A String", # A link that corresponds to the user review on Google Maps.
+                      },
+                    ],
+                    "url": "A String",
+                  },
+                ],
+                "widgetContextToken": "A String",
+              },
+            ],
+          },
+          "googleSearchResult": { # Google Search result step.
+            "isError": True or False, # Whether the Google Search resulted in an error.
+            "result": [ # Required. The results of the Google Search.
+              { # The result of the Google Search.
+                "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+              },
+            ],
+          },
+          "mcpServerToolResult": { # MCPServer tool result step.
+            "name": "A String", # Name of the tool which is called for this specific tool call.
+            "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiValue
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+            },
+            "serverName": "A String", # The name of the used MCP server.
+          },
+          "processingResult": { # The result of a server-initiated media processing step.
+          },
+          "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
+            "isError": True or False, # Whether the retrieval resulted in an error.
+          },
+          "signature": "A String", # A signature hash for backend validation.
+          "urlContextResult": { # URL context result step.
+            "isError": True or False, # Whether the URL context resulted in an error.
+            "result": [ # Required. The results of the URL context.
+              { # The result of the URL context.
+                "status": "A String", # The status of the URL retrieval.
+                "url": "A String", # The URL that was fetched.
+              },
+            ],
+          },
+        },
+        "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only
+          "contentList": { # A list of Content. # The content of the step. An array of Content objects.
+            "contents": [ # The contents of the list.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "contentString": "A String", # The content of the step. A single string.
+        },
+      },
+      "stepDelta": { # One chunk of a streamed step, carrying only the content generated since the previous chunk. Chunks sharing an `index` belong to one step and concatenate in the order received.
+        "delta": {
+          "argumentsDelta": {
+            "arguments": "A String",
+          },
+          "audio": {
+            "channels": 42, # The number of audio channels.
+            "data": "A String",
+            "mimeType": "A String",
+            "rate": 42, # Deprecated. Use sample_rate instead. The value is ignored.
+            "sampleRate": 42, # The sample rate of the audio.
+            "uri": "A String",
+          },
+          "document": {
+            "data": "A String",
+            "mimeType": "A String",
+            "uri": "A String",
+          },
+          "functionResult": {
+            "isError": True or False,
+            "name": "A String",
+            "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+              "boolValue": True or False, # Represents a boolean value.
+              "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+              "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                "values": [ # Repeated field of dynamically typed values.
+                  # Object with schema name: GenaiValue
+                ],
+              },
+              "nullValue": "A String", # Represents a null value.
+              "numberValue": 3.14, # Represents a double value.
+              "stringValue": "A String", # Represents a string value.
+              "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+            },
+          },
+          "image": {
+            "data": "A String",
+            "mimeType": "A String",
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String",
+          },
+          "serverToolCall": {
+            "codeExecutionCall": {
+              "arguments": { # The arguments to pass to the code execution.
+                "code": "A String", # The code to be executed.
+                "language": "A String", # Programming language of the `code`.
+              },
+            },
+            "fileSearchCall": {
+            },
+            "googleMapsCall": {
+              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                "queries": [ # The queries to be executed.
+                  "A String",
+                ],
+              },
+            },
+            "googleSearchCall": {
+              "arguments": { # The arguments to pass to Google Search.
+                "queries": [ # Web search queries for the following-up web search.
+                  "A String",
+                ],
+              },
+            },
+            "mcpServerToolCall": {
+              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": { # User provided metadata about the retrieved context.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                                "speaker": "A String", # The speaker to associate with this turn.
+                                "style": "A String", # Style instruction for the speech synthesis.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                                "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "text": "A String", # The transcribed word.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                          "processingConfig": {
+                            "static": {
+                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                              "fps": 3.14, # Optional. Video frame-rate sampling density.
+                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                            },
+                          },
+                          "processingType": "A String",
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiValue
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+                    },
+                  },
+                ],
+              },
+              "name": "A String",
+              "serverName": "A String",
+            },
+            "processingCall": { # Streaming delta for a server-initiated media processing step.
+            },
+            "retrievalCall": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
+              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the Retrieval tool.
+                "queries": [ # Queries for Retrieval information.
+                  "A String",
+                ],
+              },
+              "retrievalType": "A String", # The type of retrieval tools.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextCall": {
+              "arguments": { # The arguments to pass to the URL context.
+                "urls": [ # The URLs to fetch.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "serverToolResult": {
+            "codeExecutionResult": {
+              "isError": True or False,
+              "result": "A String",
+            },
+            "fileSearchResult": {
+              "result": [
+                { # The result of the File Search.
+                },
+              ],
+            },
+            "googleMapsResult": {
+              "result": [ # The results of the Google Maps.
+                { # The result of the Google Maps.
+                  "places": [ # The places that were found.
+                    {
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                  ],
+                  "widgetContextToken": "A String", # Resource name of the Google Maps widget context token.
+                },
+              ],
+            },
+            "googleSearchResult": {
+              "isError": True or False,
+              "result": [
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                },
+              ],
+            },
+            "mcpServerToolResult": {
+              "name": "A String",
+              "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": { # User provided metadata about the retrieved context.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                          "speaker": "A String", # The speaker to associate with this turn.
+                          "style": "A String", # Style instruction for the speech synthesis.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                          "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "text": "A String", # The transcribed word.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                    "processingConfig": {
+                      "static": {
+                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                        "fps": 3.14, # Optional. Video frame-rate sampling density.
+                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                      },
+                    },
+                    "processingType": "A String",
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiValue
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
+                "numberValue": 3.14, # Represents a double value.
+                "stringValue": "A String", # Represents a string value.
+                "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+              },
+              "serverName": "A String",
+            },
+            "processingResult": { # Streaming delta for the result of a server-initiated media processing step.
+            },
+            "retrievalResult": { # Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
+              "isError": True or False, # Whether the retrieval resulted in an error.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextResult": {
+              "isError": True or False,
+              "result": [
+                { # The result of the URL context.
+                  "status": "A String", # The status of the URL retrieval.
+                  "url": "A String", # The URL that was fetched.
+                },
+              ],
+            },
+          },
+          "text": {
+            "text": "A String",
+          },
+          "textAnnotationDelta": {
+            "annotations": [ # Citation information for model-generated content.
+              { # Citation information for model-generated content.
+                "endIndex": 42, # End of the attributed segment, exclusive.
+                "fileCitation": { # A file citation annotation. # A file citation annotation.
+                  "customMetadata": { # User provided metadata about the retrieved context.
+                    "a_key": "", # Properties of the object.
+                  },
+                  "documentUri": "A String", # The URI of the file.
+                  "fileName": "A String", # The name of the file.
+                  "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                  "pageNumber": 42, # Page number of the cited document, if applicable.
+                  "source": "A String", # Source attributed for a portion of the text.
+                },
+                "placeCitation": { # A place citation annotation. # A place citation annotation.
+                  "name": "A String", # Title of the place.
+                  "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                  "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                    { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                      "reviewId": "A String", # The ID of the review snippet.
+                      "title": "A String", # Title of the review.
+                      "url": "A String", # A link that corresponds to the user review on Google Maps.
+                    },
+                  ],
+                  "url": "A String", # URI reference of the place.
+                },
+                "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                  "speaker": "A String", # The speaker to associate with this turn.
+                  "style": "A String", # Style instruction for the speech synthesis.
+                },
+                "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                  "title": "A String", # The title of the URL.
+                  "url": "A String", # The URL.
+                },
+                "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                  "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                  "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                  "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                  "text": "A String", # The transcribed word.
+                },
+              },
+            ],
+          },
+          "thoughtSignature": {
+            "signature": "A String", # Signature to match the backend source to be part of the generation.
+          },
+          "thoughtSummary": {
+            "content": { # The content of the response. # A new summary item to be added to the thought.
+              "audio": { # An audio content block.
+                "channels": 42, # The number of audio channels.
+                "data": "A String", # The audio content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "sampleRate": 42, # The sample rate of the audio.
+                "uri": "A String", # The URI of the audio.
+              },
+              "document": { # A document content block.
+                "data": "A String", # The document content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "uri": "A String", # The URI of the document.
+              },
+              "image": { # An image content block.
+                "data": "A String", # The image content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the image.
+              },
+              "text": { # A text content block.
+                "annotations": [ # Citation information for model-generated content.
+                  { # Citation information for model-generated content.
+                    "endIndex": 42, # End of the attributed segment, exclusive.
+                    "fileCitation": { # A file citation annotation. # A file citation annotation.
+                      "customMetadata": { # User provided metadata about the retrieved context.
+                        "a_key": "", # Properties of the object.
+                      },
+                      "documentUri": "A String", # The URI of the file.
+                      "fileName": "A String", # The name of the file.
+                      "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                      "pageNumber": 42, # Page number of the cited document, if applicable.
+                      "source": "A String", # Source attributed for a portion of the text.
+                    },
+                    "placeCitation": { # A place citation annotation. # A place citation annotation.
+                      "name": "A String", # Title of the place.
+                      "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                      "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String", # URI reference of the place.
+                    },
+                    "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                      "speaker": "A String", # The speaker to associate with this turn.
+                      "style": "A String", # Style instruction for the speech synthesis.
+                    },
+                    "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                    "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                      "title": "A String", # The title of the URL.
+                      "url": "A String", # The URL.
+                    },
+                    "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                      "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                      "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                      "text": "A String", # The transcribed word.
+                    },
+                  },
+                ],
+                "text": "A String", # Required. The text content.
+              },
+              "video": { # A video content block.
+                "data": "A String", # The video content.
+                "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                "processingConfig": {
+                  "static": {
+                    "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                    "fps": 3.14, # Optional. Video frame-rate sampling density.
+                    "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                  },
+                },
+                "processingType": "A String",
+                "resolution": "A String", # The resolution of the media.
+                "uri": "A String", # The URI of the video.
+              },
+            },
+          },
+          "video": {
+            "data": "A String",
+            "mimeType": "A String",
+            "resolution": "A String", # The resolution of the media.
+            "uri": "A String",
+          },
+        },
+        "index": 42,
+      },
+      "stepStart": { # Opens a streamed step. Emitted only under `TaskSpec.delta_streaming`, which documents the two delivery modes in full. Under `delta_streaming` EVERY step arrives as a `step_start` / `step_delta`* / `step_stop` run sharing an `index`, and a bare `step` is never emitted. Reassembling a run yields the same Step that `step` above would otherwise have delivered. What follows a `step_start` depends on whether the content is generated progressively. Assistant text (and the citations on it) and thoughts stream across the run's `step_delta`s as they are produced, so for those this field carries the step's shape (role, type) with its generated content left empty. A step that arrives whole -- tool calls, tool results, elicitations, user-input echoes, errors -- carries no `step_delta` at all: the COMPLETE step rides this field, and `step_stop` closes the run.
+        "index": 42,
+        "step": { # A step in the interaction.
+          "modelOutput": { # Output generated by the model.
+            "content": [
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+            "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+              "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+              "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+                {
+                  "a_key": "", # Properties of the object. Contains field @type with type URL.
+                },
+              ],
+              "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+            },
+          },
+          "thought": { # A thought step.
+            "signature": "A String", # A signature hash for backend validation.
+            "summary": [ # A summary of the thought.
+              { # The content of the response.
+                "audio": { # An audio content block.
+                  "channels": 42, # The number of audio channels.
+                  "data": "A String", # The audio content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "sampleRate": 42, # The sample rate of the audio.
+                  "uri": "A String", # The URI of the audio.
+                },
+                "document": { # A document content block.
+                  "data": "A String", # The document content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "uri": "A String", # The URI of the document.
+                },
+                "image": { # An image content block.
+                  "data": "A String", # The image content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the image.
+                },
+                "text": { # A text content block.
+                  "annotations": [ # Citation information for model-generated content.
+                    { # Citation information for model-generated content.
+                      "endIndex": 42, # End of the attributed segment, exclusive.
+                      "fileCitation": { # A file citation annotation. # A file citation annotation.
+                        "customMetadata": { # User provided metadata about the retrieved context.
+                          "a_key": "", # Properties of the object.
+                        },
+                        "documentUri": "A String", # The URI of the file.
+                        "fileName": "A String", # The name of the file.
+                        "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                        "pageNumber": 42, # Page number of the cited document, if applicable.
+                        "source": "A String", # Source attributed for a portion of the text.
+                      },
+                      "placeCitation": { # A place citation annotation. # A place citation annotation.
+                        "name": "A String", # Title of the place.
+                        "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                        "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                          { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                            "reviewId": "A String", # The ID of the review snippet.
+                            "title": "A String", # Title of the review.
+                            "url": "A String", # A link that corresponds to the user review on Google Maps.
+                          },
+                        ],
+                        "url": "A String", # URI reference of the place.
+                      },
+                      "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                        "speaker": "A String", # The speaker to associate with this turn.
+                        "style": "A String", # Style instruction for the speech synthesis.
+                      },
+                      "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                      "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                        "title": "A String", # The title of the URL.
+                        "url": "A String", # The URL.
+                      },
+                      "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                        "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                        "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                        "text": "A String", # The transcribed word.
+                      },
+                    },
+                  ],
+                  "text": "A String", # Required. The text content.
+                },
+                "video": { # A video content block.
+                  "data": "A String", # The video content.
+                  "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                  "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                  "processingConfig": {
+                    "static": {
+                      "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                      "fps": 3.14, # Optional. Video frame-rate sampling density.
+                      "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                    },
+                  },
+                  "processingType": "A String",
+                  "resolution": "A String", # The resolution of the media.
+                  "uri": "A String", # The URI of the video.
+                },
+              },
+            ],
+          },
+          "toolCall": { # Tool call step.
+            "codeExecutionCall": { # Code execution call step.
+              "arguments": { # The arguments to pass to the code execution. # Required. The arguments to pass to the code execution.
+                "code": "A String", # The code to be executed.
+                "language": "A String", # Programming language of the `code`.
+              },
+            },
+            "fileSearchCall": { # File Search call step.
+            },
+            "functionCall": { # A function tool call step.
+              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The arguments to pass to the function.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": { # User provided metadata about the retrieved context.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                                "speaker": "A String", # The speaker to associate with this turn.
+                                "style": "A String", # Style instruction for the speech synthesis.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                                "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "text": "A String", # The transcribed word.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                          "processingConfig": {
+                            "static": {
+                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                              "fps": 3.14, # Optional. Video frame-rate sampling density.
+                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                            },
+                          },
+                          "processingType": "A String",
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiValue
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Required. The name of the tool to call.
+            },
+            "googleMapsCall": { # Google Maps call step.
+              "arguments": { # The arguments to pass to the Google Maps tool. # The arguments to pass to the Google Maps tool.
+                "queries": [ # The queries to be executed.
+                  "A String",
+                ],
+              },
+            },
+            "googleSearchCall": { # Google Search call step.
+              "arguments": { # The arguments to pass to Google Search. # Required. The arguments to pass to Google Search.
+                "queries": [ # Web search queries for the following-up web search.
+                  "A String",
+                ],
+              },
+              "searchType": "A String", # The type of search grounding enabled.
+            },
+            "id": "A String", # Required. A unique ID for this specific tool call.
+            "mcpServerToolCall": { # MCPServer tool call step.
+              "arguments": { # `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. # Required. The JSON object of arguments for the function.
+                "fields": [ # Dynamically typed fields. List instead of map because LLMs are sensitive to ordering, and we want to give users full control.
+                  { # Represents a single field in a struct.
+                    "name": "A String",
+                    "value": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.
+                      "boolValue": True or False, # Represents a boolean value.
+                      "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                        "audio": { # An audio content block.
+                          "channels": 42, # The number of audio channels.
+                          "data": "A String", # The audio content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "sampleRate": 42, # The sample rate of the audio.
+                          "uri": "A String", # The URI of the audio.
+                        },
+                        "document": { # A document content block.
+                          "data": "A String", # The document content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "uri": "A String", # The URI of the document.
+                        },
+                        "image": { # An image content block.
+                          "data": "A String", # The image content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the image.
+                        },
+                        "text": { # A text content block.
+                          "annotations": [ # Citation information for model-generated content.
+                            { # Citation information for model-generated content.
+                              "endIndex": 42, # End of the attributed segment, exclusive.
+                              "fileCitation": { # A file citation annotation. # A file citation annotation.
+                                "customMetadata": { # User provided metadata about the retrieved context.
+                                  "a_key": "", # Properties of the object.
+                                },
+                                "documentUri": "A String", # The URI of the file.
+                                "fileName": "A String", # The name of the file.
+                                "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                                "pageNumber": 42, # Page number of the cited document, if applicable.
+                                "source": "A String", # Source attributed for a portion of the text.
+                              },
+                              "placeCitation": { # A place citation annotation. # A place citation annotation.
+                                "name": "A String", # Title of the place.
+                                "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                                "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                                  { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                    "reviewId": "A String", # The ID of the review snippet.
+                                    "title": "A String", # Title of the review.
+                                    "url": "A String", # A link that corresponds to the user review on Google Maps.
+                                  },
+                                ],
+                                "url": "A String", # URI reference of the place.
+                              },
+                              "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                                "speaker": "A String", # The speaker to associate with this turn.
+                                "style": "A String", # Style instruction for the speech synthesis.
+                              },
+                              "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                              "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                                "title": "A String", # The title of the URL.
+                                "url": "A String", # The URL.
+                              },
+                              "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                                "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                                "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                                "text": "A String", # The transcribed word.
+                              },
+                            },
+                          ],
+                          "text": "A String", # Required. The text content.
+                        },
+                        "video": { # A video content block.
+                          "data": "A String", # The video content.
+                          "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                          "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                          "processingConfig": {
+                            "static": {
+                              "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                              "fps": 3.14, # Optional. Video frame-rate sampling density.
+                              "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                            },
+                          },
+                          "processingType": "A String",
+                          "resolution": "A String", # The resolution of the media.
+                          "uri": "A String", # The URI of the video.
+                        },
+                      },
+                      "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                        "values": [ # Repeated field of dynamically typed values.
+                          # Object with schema name: GenaiValue
+                        ],
+                      },
+                      "nullValue": "A String", # Represents a null value.
+                      "numberValue": 3.14, # Represents a double value.
+                      "stringValue": "A String", # Represents a string value.
+                      "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+                    },
+                  },
+                ],
+              },
+              "name": "A String", # Required. The name of the tool which was called.
+              "serverName": "A String", # Required. The name of the used MCP server.
+            },
+            "processingCall": { # A server-initiated processing step for media analysis (e.g. video understanding).
+            },
+            "retrievalCall": { # Retrieval call step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. RetrievalType decides which tool is used.
+              "arguments": { # The arguments to pass to Retrieval tools. # Required. The arguments to pass to the retrieval tool.
+                "queries": [ # Queries for Retrieval information.
+                  "A String",
+                ],
+              },
+              "retrievalType": "A String", # The type of retrieval tools.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextCall": { # URL context call step.
+              "arguments": { # The arguments to pass to the URL context. # Required. The arguments to pass to the URL context.
+                "urls": [ # The URLs to fetch.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "toolResult": { # Tool result step.
+            "callId": "A String", # Required. ID to match the ID from the function call block.
+            "codeExecutionResult": { # Code execution result step.
+              "content": { # A list of Content. # Multimodal output of the code execution.
+                "contents": [ # The contents of the list.
+                  { # The content of the response.
+                    "audio": { # An audio content block.
+                      "channels": 42, # The number of audio channels.
+                      "data": "A String", # The audio content.
+                      "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                      "sampleRate": 42, # The sample rate of the audio.
+                      "uri": "A String", # The URI of the audio.
+                    },
+                    "document": { # A document content block.
+                      "data": "A String", # The document content.
+                      "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                      "uri": "A String", # The URI of the document.
+                    },
+                    "image": { # An image content block.
+                      "data": "A String", # The image content.
+                      "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the image.
+                    },
+                    "text": { # A text content block.
+                      "annotations": [ # Citation information for model-generated content.
+                        { # Citation information for model-generated content.
+                          "endIndex": 42, # End of the attributed segment, exclusive.
+                          "fileCitation": { # A file citation annotation. # A file citation annotation.
+                            "customMetadata": { # User provided metadata about the retrieved context.
+                              "a_key": "", # Properties of the object.
+                            },
+                            "documentUri": "A String", # The URI of the file.
+                            "fileName": "A String", # The name of the file.
+                            "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                            "pageNumber": 42, # Page number of the cited document, if applicable.
+                            "source": "A String", # Source attributed for a portion of the text.
+                          },
+                          "placeCitation": { # A place citation annotation. # A place citation annotation.
+                            "name": "A String", # Title of the place.
+                            "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                            "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                              { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                                "reviewId": "A String", # The ID of the review snippet.
+                                "title": "A String", # Title of the review.
+                                "url": "A String", # A link that corresponds to the user review on Google Maps.
+                              },
+                            ],
+                            "url": "A String", # URI reference of the place.
+                          },
+                          "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                            "speaker": "A String", # The speaker to associate with this turn.
+                            "style": "A String", # Style instruction for the speech synthesis.
+                          },
+                          "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                          "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                            "title": "A String", # The title of the URL.
+                            "url": "A String", # The URL.
+                          },
+                          "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                            "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                            "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                            "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                            "text": "A String", # The transcribed word.
+                          },
+                        },
+                      ],
+                      "text": "A String", # Required. The text content.
+                    },
+                    "video": { # A video content block.
+                      "data": "A String", # The video content.
+                      "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                      "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                      "processingConfig": {
+                        "static": {
+                          "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                          "fps": 3.14, # Optional. Video frame-rate sampling density.
+                          "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                        },
+                      },
+                      "processingType": "A String",
+                      "resolution": "A String", # The resolution of the media.
+                      "uri": "A String", # The URI of the video.
+                    },
+                  },
+                ],
+              },
+              "isError": True or False, # Whether the code execution resulted in an error.
+              "result": "A String", # Required. The output of the code execution.
+            },
+            "fileSearchResult": { # File Search result step.
+            },
+            "functionResult": { # Result of a function tool call.
+              "isError": True or False, # Whether the tool call resulted in an error.
+              "name": "A String", # The name of the tool that was called.
+              "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": { # User provided metadata about the retrieved context.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                          "speaker": "A String", # The speaker to associate with this turn.
+                          "style": "A String", # Style instruction for the speech synthesis.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                          "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "text": "A String", # The transcribed word.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                    "processingConfig": {
+                      "static": {
+                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                        "fps": 3.14, # Optional. Video frame-rate sampling density.
+                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                      },
+                    },
+                    "processingType": "A String",
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiValue
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
+                "numberValue": 3.14, # Represents a double value.
+                "stringValue": "A String", # Represents a string value.
+                "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+              },
+            },
+            "googleMapsResult": { # Google Maps result step.
+              "result": [
+                { # The result of the Google Maps.
+                  "places": [
+                    {
+                      "name": "A String",
+                      "placeId": "A String",
+                      "reviewSnippets": [
+                        { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                          "reviewId": "A String", # The ID of the review snippet.
+                          "title": "A String", # Title of the review.
+                          "url": "A String", # A link that corresponds to the user review on Google Maps.
+                        },
+                      ],
+                      "url": "A String",
+                    },
+                  ],
+                  "widgetContextToken": "A String",
+                },
+              ],
+            },
+            "googleSearchResult": { # Google Search result step.
+              "isError": True or False, # Whether the Google Search resulted in an error.
+              "result": [ # Required. The results of the Google Search.
+                { # The result of the Google Search.
+                  "searchSuggestions": "A String", # Web content snippet that can be embedded in a web page or an app webview.
+                },
+              ],
+            },
+            "mcpServerToolResult": { # MCPServer tool result step.
+              "name": "A String", # Name of the tool which is called for this specific tool call.
+              "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The output from the MCP server call. Can be simple text or rich content.
+                "boolValue": True or False, # Represents a boolean value.
+                "contentValue": { # The content of the response. # Represents rich content (text, image, etc.).
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": { # User provided metadata about the retrieved context.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                          "speaker": "A String", # The speaker to associate with this turn.
+                          "style": "A String", # Style instruction for the speech synthesis.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                          "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "text": "A String", # The transcribed word.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                    "processingConfig": {
+                      "static": {
+                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                        "fps": 3.14, # Optional. Video frame-rate sampling density.
+                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                      },
+                    },
+                    "processingType": "A String",
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+                "listValue": { # `ListValue` is a wrapper around a repeated field of values. # Represents a repeated `Value`.
+                  "values": [ # Repeated field of dynamically typed values.
+                    # Object with schema name: GenaiValue
+                  ],
+                },
+                "nullValue": "A String", # Represents a null value.
+                "numberValue": 3.14, # Represents a double value.
+                "stringValue": "A String", # Represents a string value.
+                "structValue": # Object with schema name: GenaiStruct # Represents a structured value.
+              },
+              "serverName": "A String", # The name of the used MCP server.
+            },
+            "processingResult": { # The result of a server-initiated media processing step.
+            },
+            "retrievalResult": { # Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc.
+              "isError": True or False, # Whether the retrieval resulted in an error.
+            },
+            "signature": "A String", # A signature hash for backend validation.
+            "urlContextResult": { # URL context result step.
+              "isError": True or False, # Whether the URL context resulted in an error.
+              "result": [ # Required. The results of the URL context.
+                { # The result of the URL context.
+                  "status": "A String", # The status of the URL retrieval.
+                  "url": "A String", # The URL that was fetched.
+                },
+              ],
+            },
+          },
+          "userInput": { # Input provided by the user. # DO NOT USE -- These are for 3P JSON only
+            "contentList": { # A list of Content. # The content of the step. An array of Content objects.
+              "contents": [ # The contents of the list.
+                { # The content of the response.
+                  "audio": { # An audio content block.
+                    "channels": 42, # The number of audio channels.
+                    "data": "A String", # The audio content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "sampleRate": 42, # The sample rate of the audio.
+                    "uri": "A String", # The URI of the audio.
+                  },
+                  "document": { # A document content block.
+                    "data": "A String", # The document content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "uri": "A String", # The URI of the document.
+                  },
+                  "image": { # An image content block.
+                    "data": "A String", # The image content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the image.
+                  },
+                  "text": { # A text content block.
+                    "annotations": [ # Citation information for model-generated content.
+                      { # Citation information for model-generated content.
+                        "endIndex": 42, # End of the attributed segment, exclusive.
+                        "fileCitation": { # A file citation annotation. # A file citation annotation.
+                          "customMetadata": { # User provided metadata about the retrieved context.
+                            "a_key": "", # Properties of the object.
+                          },
+                          "documentUri": "A String", # The URI of the file.
+                          "fileName": "A String", # The name of the file.
+                          "mediaId": "A String", # Media ID in-case of image citations, if applicable.
+                          "pageNumber": 42, # Page number of the cited document, if applicable.
+                          "source": "A String", # Source attributed for a portion of the text.
+                        },
+                        "placeCitation": { # A place citation annotation. # A place citation annotation.
+                          "name": "A String", # Title of the place.
+                          "placeId": "A String", # The ID of the place, in `places/{place_id}` format.
+                          "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.
+                            { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps.
+                              "reviewId": "A String", # The ID of the review snippet.
+                              "title": "A String", # Title of the review.
+                              "url": "A String", # A link that corresponds to the user review on Google Maps.
+                            },
+                          ],
+                          "url": "A String", # URI reference of the place.
+                        },
+                        "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content.
+                          "speaker": "A String", # The speaker to associate with this turn.
+                          "style": "A String", # Style instruction for the speech synthesis.
+                        },
+                        "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.
+                        "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation.
+                          "title": "A String", # The title of the URL.
+                          "url": "A String", # The URL.
+                        },
+                        "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info.
+                          "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig.
+                          "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word".
+                          "text": "A String", # The transcribed word.
+                        },
+                      },
+                    ],
+                    "text": "A String", # Required. The text content.
+                  },
+                  "video": { # A video content block.
+                    "data": "A String", # The video content.
+                    "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key.
+                    "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response.
+                    "processingConfig": {
+                      "static": {
+                        "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set.
+                        "fps": 3.14, # Optional. Video frame-rate sampling density.
+                        "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative.
+                      },
+                    },
+                    "processingType": "A String",
+                    "resolution": "A String", # The resolution of the media.
+                    "uri": "A String", # The URI of the video.
+                  },
+                },
+              ],
+            },
+            "contentString": "A String", # The content of the step. A single string.
+          },
+        },
+      },
+      "stepStop": { # Closes a streamed step, carrying its token usage. No further `step_delta` arrives for this `index`.
+        "index": 42,
+        "stepUsage": { # Statistics on the interaction request's token usage. # Model usage stats for this specific step.
+          "billableUsage": { # Accumulated billable token usage across all continuation calls. # Accumulated billable token usage across all continuation calls.
+            "totalCachedTokens": 42, # Total billable cached tokens across all continuation calls.
+            "totalInputTokens": 42, # Total billable input tokens across all continuation calls.
+            "totalOutputTokens": 42, # Total billable output tokens across all continuation calls.
+            "totalThoughtTokens": 42, # Total billable thought tokens across all continuation calls.
+            "totalTokens": 42, # Total billable token count across all continuation calls.
+          },
+          "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.
+            },
+          ],
+          "compactionUsageMetadata": { # Token usage metadata for context compaction. # Token usage metadata for context compaction.
+            "inputTokenCount": 42, # Number of tokens processed in the compaction input.
+            "outputTokenCount": 42, # Number of tokens generated in the compaction output.
+            "postcompactionTokenCount": "A String", # Estimated total token count of the conversation context after compaction.
+            "precompactionStepCount": 42, # Number of conversation steps (user turns) before compaction.
+            "precompactionTokenCount": "A String", # Estimated total token count of the conversation context before compaction.
+          },
+          "groundingToolCount": [ # Grounding tool count.
+            { # The number of grounding tool counts.
+              "count": 42, # The number of grounding tool counts.
+              "searchQueryCount": 42, # Number of unique search queries generated by the model for this tool.
+              "type": "A String", # The grounding tool type associated with the count.
+            },
+          ],
+          "initialInputTokens": 42, # Number of input tokens used in the first turn of this interaction.
+          "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.
+            },
+          ],
+          "modelInvocationTokenCounts": [ # Per-invocation token count breakdown. For simple requests, this contains a single entry. For requests with server-side tool use, this contains one entry per model invocation, ordered chronologically. This is the source of truth for billing.
+            { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+              "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+                { # 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.
+                },
+              ],
+              "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+                { # 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.
+                },
+              ],
+              "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+                { # 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.
+                },
+              ],
+              "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+                { # 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.
+                },
+              ],
+            },
+          ],
+          "nonGroundingModelInvocationTokenCounts": [ # Per-invocation token count breakdown for non-grounding invocations (grounding prompt/cache tokens excluded).
+            { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+              "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+                { # 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.
+                },
+              ],
+              "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+                { # 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.
+                },
+              ],
+              "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+                { # 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.
+                },
+              ],
+              "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+                { # 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.
+            },
+          ],
+          "rawPromptToken": 42, # Output only.
+          "toolCallUsage": [ # Output only. Per-tool call statistics, sorted by (`tool_type`, `name`).
+            { # Usage statistics for one tool, aggregated over the interaction.
+              "name": "A String", # The function name as declared in the request. Set only when `tool_type` is TOOL_TYPE_FUNCTION; empty for all other tool types.
+              "serverExecutedCount": 42, # Of `tool_call_count`, calls dispatched to and run by the server, whether or not they succeeded.
+              "toolCallCount": 42, # Number of calls to this tool that the model generated.
+              "toolType": "A String",
+            },
+          ],
+          "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).
+          "totalModelInvocations": 42, # Total number of LLM model invocations executed during the interaction turn (including retries and multi-step tool loop calls).
+          "totalOutputTokens": 42, # Total number of tokens across all the generated responses.
+          "totalThoughtTokens": 42, # Number of tokens of thoughts for thinking models.
+          "totalTokens": 42, # Total token count for the interaction request (prompt + responses + other internal tokens).
+          "totalToolUseTokens": 42, # Number of tokens present in tool-use prompt(s).
+        },
+        "usage": { # Statistics on the interaction request's token usage. # Cumulative model usage stats from the start of the session.
+          "billableUsage": { # Accumulated billable token usage across all continuation calls. # Accumulated billable token usage across all continuation calls.
+            "totalCachedTokens": 42, # Total billable cached tokens across all continuation calls.
+            "totalInputTokens": 42, # Total billable input tokens across all continuation calls.
+            "totalOutputTokens": 42, # Total billable output tokens across all continuation calls.
+            "totalThoughtTokens": 42, # Total billable thought tokens across all continuation calls.
+            "totalTokens": 42, # Total billable token count across all continuation calls.
+          },
+          "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.
+            },
+          ],
+          "compactionUsageMetadata": { # Token usage metadata for context compaction. # Token usage metadata for context compaction.
+            "inputTokenCount": 42, # Number of tokens processed in the compaction input.
+            "outputTokenCount": 42, # Number of tokens generated in the compaction output.
+            "postcompactionTokenCount": "A String", # Estimated total token count of the conversation context after compaction.
+            "precompactionStepCount": 42, # Number of conversation steps (user turns) before compaction.
+            "precompactionTokenCount": "A String", # Estimated total token count of the conversation context before compaction.
+          },
+          "groundingToolCount": [ # Grounding tool count.
+            { # The number of grounding tool counts.
+              "count": 42, # The number of grounding tool counts.
+              "searchQueryCount": 42, # Number of unique search queries generated by the model for this tool.
+              "type": "A String", # The grounding tool type associated with the count.
+            },
+          ],
+          "initialInputTokens": 42, # Number of input tokens used in the first turn of this interaction.
+          "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.
+            },
+          ],
+          "modelInvocationTokenCounts": [ # Per-invocation token count breakdown. For simple requests, this contains a single entry. For requests with server-side tool use, this contains one entry per model invocation, ordered chronologically. This is the source of truth for billing.
+            { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+              "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+                { # 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.
+                },
+              ],
+              "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+                { # 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.
+                },
+              ],
+              "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+                { # 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.
+                },
+              ],
+              "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+                { # 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.
+                },
+              ],
+            },
+          ],
+          "nonGroundingModelInvocationTokenCounts": [ # Per-invocation token count breakdown for non-grounding invocations (grounding prompt/cache tokens excluded).
+            { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+              "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+                { # 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.
+                },
+              ],
+              "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+                { # 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.
+                },
+              ],
+              "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+                { # 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.
+                },
+              ],
+              "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+                { # 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.
+            },
+          ],
+          "rawPromptToken": 42, # Output only.
+          "toolCallUsage": [ # Output only. Per-tool call statistics, sorted by (`tool_type`, `name`).
+            { # Usage statistics for one tool, aggregated over the interaction.
+              "name": "A String", # The function name as declared in the request. Set only when `tool_type` is TOOL_TYPE_FUNCTION; empty for all other tool types.
+              "serverExecutedCount": 42, # Of `tool_call_count`, calls dispatched to and run by the server, whether or not they succeeded.
+              "toolCallCount": 42, # Number of calls to this tool that the model generated.
+              "toolType": "A String",
+            },
+          ],
+          "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).
+          "totalModelInvocations": 42, # Total number of LLM model invocations executed during the interaction turn (including retries and multi-step tool loop calls).
+          "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).
+        },
+      },
+      "stepUsage": { # Statistics on the interaction request's token usage. # Optional. Token usage for one model call. Populated on at most one event per model call regardless of `TaskSpec.delta_streaming`, and absent on non-model events (tool results, user-input echoes, status changes).
+        "billableUsage": { # Accumulated billable token usage across all continuation calls. # Accumulated billable token usage across all continuation calls.
+          "totalCachedTokens": 42, # Total billable cached tokens across all continuation calls.
+          "totalInputTokens": 42, # Total billable input tokens across all continuation calls.
+          "totalOutputTokens": 42, # Total billable output tokens across all continuation calls.
+          "totalThoughtTokens": 42, # Total billable thought tokens across all continuation calls.
+          "totalTokens": 42, # Total billable token count across all continuation calls.
+        },
+        "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.
+          },
+        ],
+        "compactionUsageMetadata": { # Token usage metadata for context compaction. # Token usage metadata for context compaction.
+          "inputTokenCount": 42, # Number of tokens processed in the compaction input.
+          "outputTokenCount": 42, # Number of tokens generated in the compaction output.
+          "postcompactionTokenCount": "A String", # Estimated total token count of the conversation context after compaction.
+          "precompactionStepCount": 42, # Number of conversation steps (user turns) before compaction.
+          "precompactionTokenCount": "A String", # Estimated total token count of the conversation context before compaction.
+        },
+        "groundingToolCount": [ # Grounding tool count.
+          { # The number of grounding tool counts.
+            "count": 42, # The number of grounding tool counts.
+            "searchQueryCount": 42, # Number of unique search queries generated by the model for this tool.
+            "type": "A String", # The grounding tool type associated with the count.
+          },
+        ],
+        "initialInputTokens": 42, # Number of input tokens used in the first turn of this interaction.
+        "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.
+          },
+        ],
+        "modelInvocationTokenCounts": [ # Per-invocation token count breakdown. For simple requests, this contains a single entry. For requests with server-side tool use, this contains one entry per model invocation, ordered chronologically. This is the source of truth for billing.
+          { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+            "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+              { # 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.
+              },
+            ],
+            "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+              { # 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.
+              },
+            ],
+            "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+              { # 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.
+              },
+            ],
+            "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+              { # 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.
+              },
+            ],
+          },
+        ],
+        "nonGroundingModelInvocationTokenCounts": [ # Per-invocation token count breakdown for non-grounding invocations (grounding prompt/cache tokens excluded).
+          { # Token count breakdown for a single model invocation (main model only) within a request. For simple requests without tool use, there is a single invocation. For requests with server-side tool use, there is one invocation per tool-use iteration.
+            "cacheTokensDetails": [ # Per-modality breakdown of cached tokens within this invocation's prompt. Cached tokens are discounted for billing (priced at the cache rate, not the full input rate). This is a subset of prompt_tokens_details.
+              { # 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.
+              },
+            ],
+            "candidatesTokensDetails": [ # Per-modality breakdown of response tokens for this invocation. Includes the model's text output, function calls, or final answer. Does not include thought tokens.
+              { # 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.
+              },
+            ],
+            "promptTokensDetails": [ # Per-modality breakdown of prompt tokens for this invocation. Includes all tokens sent to the model: user content, system instructions, formatting/control tokens, tool declarations, and any previous-turn context accumulated during tool use.
+              { # 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.
+              },
+            ],
+            "thoughtsTokensDetails": [ # Per-modality breakdown of thought tokens for this invocation (for thinking models). Includes auxiliary control tokens produced by the model that delimit thought blocks.
+              { # 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.
+          },
+        ],
+        "rawPromptToken": 42, # Output only.
+        "toolCallUsage": [ # Output only. Per-tool call statistics, sorted by (`tool_type`, `name`).
+          { # Usage statistics for one tool, aggregated over the interaction.
+            "name": "A String", # The function name as declared in the request. Set only when `tool_type` is TOOL_TYPE_FUNCTION; empty for all other tool types.
+            "serverExecutedCount": 42, # Of `tool_call_count`, calls dispatched to and run by the server, whether or not they succeeded.
+            "toolCallCount": 42, # Number of calls to this tool that the model generated.
+            "toolType": "A String",
           },
-          "memoryConfig": { # Task-level memory settings: which sources memory draws from, and whether memory is active for this task at all. # Optional. Memory settings for this task.
-            "disableMemory": True or False, # Optional. If true, the agent neither reads existing memories into the prompt nor forms new ones from this task. Memory is on by default, and this can only turn it off, never back on: * Agent memory enabled, this true: off for this task. * Agent memory enabled, this false or unset: on. * Agent memory disabled: off, whatever this says. Because a task belongs to a single end user's interaction, a surface that knows the user can use this to turn memory off for one user of a shared agent; memory keeps working for the agent's other users. `Agent.memory_config.disable_memory` wins because it is the mutable one. It can be turned on after tasks have already been created, and a stored task spec keeps whatever it was created with — so if a spec could re-enable memory, the agent-level switch would be unable to cover the tasks that already exist. The two are therefore OR'ed, and the agent's current value is re-applied every time a session opens, including on a resume. Scoped to this task. Memories already stored for the agent are retained and stay readable by the agent's users; this governs only whether this task can access and modify them.
-            "knowledgeCatalogConfig": { # Configuration for enterprise Knowledge Catalog metadata discovery. # Optional. Configuration for enterprise Knowledge Catalog search.
-              "enabledConnectors": [ # Optional. Filter list of system/connector technology names (e.g., "bigquery", "looker", "spanner"). If empty, all indexed catalog connectors are searched.
-                "A String",
-              ],
-              "knowledgeCatalogEnabled": True or False, # Optional. If true, enables searching enterprise metadata in Google Cloud Knowledge Catalog.
-              "projectId": "A String", # Optional. GCP project ID to scope Knowledge Catalog searches.
-            },
+        ],
+        "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.
           },
-        },
-        "subtaskConfig": { # Configuration and limits for subtasks spawned by this task. # Optional. Configuration and limits for subtasks spawned by this task.
-          "maxDepth": 42, # Optional. The maximum depth of subtask hierarchy allowed under this task. Must be between 0 and 5, inclusive. When unset on a root task, defaults to 5. For a subtask, it is clamped to at most parent.max_depth - 1 (defaulting to parent.max_depth - 1 if unspecified). A value of 0 means this task cannot spawn any subtasks.
-        },
-        "systemInstruction": "A String", # Optional. Optional standing instruction applied across the whole task.
+        ],
+        "totalCachedTokens": 42, # Number of tokens in the cached part of the prompt (the cached content).
+        "totalInputTokens": 42, # Number of tokens in the prompt (context).
+        "totalModelInvocations": 42, # Total number of LLM model invocations executed during the interaction turn (including retries and multi-step tool loop calls).
+        "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).
       },
-      "status": "A String", # Output only. The coarse, durable status of the task.
-      "statusDetail": { # Why a task is in its current status, when the status alone is not enough to act on (today: `SUSPENDED`). Clients MUST treat an unrecognized `StatusReason` as an opaque block. Copied to the DB mirror by name and number, so a field or enum value added here without the matching DB-side addition is silently dropped on write. LINT.IfChange(status_detail) # Output only. Explanation for the current state, when the state alone is not enough to act on (today: `SUSPENDED`). Cleared when the task leaves that state.
-        "detail": "A String", # Optional human-readable explanation, so a surface can render something without its own StatusReason -> string table. Not localized; clients needing localization should render from `reason` instead. Not a `google.rpc.Status`: RPC codes do not map onto lifecycle states, and `TaskOutcome.status` already covers terminal failures.
-        "reason": "A String", # Machine-readable reason. Clients switch on this to pick a recovery affordance (upsell CTA, admin contact, retry).
+      "taskUpdate": { # A change to a task's details. Surfaces out the Task resource fields that change during execution. # A change to the task's details.
+        "updates": [ # The task detail changes carried by this event.
+          { # A single task detail change.
+            "summary": "A String", # Rolling progress/outcome summary.
+            "title": "A String", # Concise title.
+          },
+        ],
       },
-      "statusUpdateTime": "A String", # Output only. The time the task's status was last updated.
-      "summary": "A String", # Output only. A rolling, system-generated summary of the task's progress/result.
-      "title": "A String", # Optional. Optional human-readable title for listing surfaces.
-      "updateTime": "A String", # Output only. The time the task was last updated.
-    },
-  ],
-}
-
- -
- listArtifacts(task, pageSize=None, pageToken=None, path=None, recursive=None, x__xgafv=None) -
Lists the files in a task's workspace. By default only the immediate children of `path` are returned; set `recursive` to descend into subdirectories. Entries are returned in breadth-first order. While the task's sandbox is running, paths it writes locally are read from the sandbox so the listing reflects files not yet synced to storage; otherwise they are read from storage. Which one served a request is not visible to the caller.
-
-Args:
-  task: string, Required. The task whose workspace to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
-  pageSize: integer, Optional. The maximum number of entries to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.
-  pageToken: string, Optional. A page token from a previous ListTaskArtifacts call. The workspace is live: the agent can write between pages, so a paged listing is not a snapshot. An entry added during the walk may or may not appear, and one removed may still be listed and then fail to download.
-  path: string, Optional. Absolute path of the directory to list, e.g. "/workspace/userdata". Must be "/workspace" or under it, at most 1024 characters, and not contain a ".." segment. Defaults to "/workspace".
-  recursive: boolean, Optional. If true, descends into subdirectories. Results are breadth-first.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for TaskService.ListTaskArtifacts.
-  "artifacts": [ # The entries under the requested directory.
-    { # A file or directory in a task's workspace.
-      "mimeType": "A String", # Output only. The detected media type. Empty for directories.
-      "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to DownloadTaskArtifact.
-      "sizeBytes": "A String", # Output only. Size of the file in bytes. Zero for directories.
-      "type": "A String", # Output only. Whether this entry is a file or a directory.
-      "updateTime": "A String", # Output only. Last modification time of the file as it was read: the sandbox's when read from a running sandbox, otherwise the stored object's.
+      "timestampMicros": "A String", # Strictly increasing generation timestamp, in unix micros.
+      "trajectoryId": "A String", # Optional. The runtime trajectory UUID that produced this event's step, e.g. "e9df8df3-d63a-4747-ad00-eaef837d7d31". A debugging correlation handle and the join key to the runtime's per-step trajectory record (for Sobi, the Trajectory Store viewer at sobi.corp.google.com/trajectory/). Set on the step-bearing events (`step` and the `step_start` of a streamed step); empty on status_changed / artifacts_changed and on the step_delta/step_stop frames continuing a run (correlate those by `index` with their step_start). Also empty on steps the Sobi converter did not build: the actor delivers `elicitation_call` as a native `Step` payload with no field 110, and `Session::ReadConverted` forwards it unchanged (`jetski_to_interaction_stream_converter.cc:1101-1104`), so a HITL turn reaches the client on `step` with `trajectory_id` empty even though a trajectory does exist for it. A whole turn shares one trajectory id. The server never derives behavior from it. See b/552010818.
     },
   ],
-  "nextPageToken": "A String", # A token to retrieve the next page; empty if there are no more pages.
+  "nextPageToken": "A String", # A token to retrieve the next page. Empty only when the task is in a terminal state and every stored event has been returned. While the task can still produce events it is set even when `events` is empty, so a caller can poll with it for events stored later.
 }
- listArtifacts_next(previous_request, previous_response) + listEvents_next(previous_request, previous_response)
Retrieves the next page of results.
 
 Args:
@@ -7001,7 +10101,7 @@ 

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -7433,6 +10533,90 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -8646,11 +11830,95 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -9886,6 +13154,90 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

uploadArtifact(task, body=None, path=None, x__xgafv=None) -
Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.
+  
Deprecated: use `ArtifactService.UploadArtifact` instead. Pass this request's `task` as its `name` and the same `path`, and send the file as media to `POST /upload/v1beta1/{name}:upload`. UploadArtifact stores the file through Scotty, takes files up to 10 GiB, and returns the stored `path`; `ArtifactService.ListWorkspaceArtifacts` returns the rest of the file's `TaskArtifactFile`. This method keeps working unchanged while callers migrate. Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.
 
 Args:
   task: string, Required. The task to upload into. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} (required)
@@ -12984,7 +16504,7 @@ 

Method Details

{ # A file or directory in a task's workspace. "mimeType": "A String", # Output only. The detected media type. Empty for directories. - "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to DownloadTaskArtifact. + "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to ArtifactService.DownloadArtifact. "sizeBytes": "A String", # Output only. Size of the file in bytes. Zero for directories. "type": "A String", # Output only. Whether this entry is a file or a directory. "updateTime": "A String", # Output only. Last modification time of the file as it was read: the sandbox's when read from a running sandbox, otherwise the stored object's. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index a654d90cdb..4af480a9d7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -174,6 +174,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -277,6 +278,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -440,10 +442,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -650,6 +652,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -753,6 +756,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -916,10 +920,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1151,6 +1155,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1254,6 +1259,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1417,10 +1423,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1638,6 +1644,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1741,6 +1748,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1904,10 +1912,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2133,6 +2141,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2236,6 +2245,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2399,10 +2409,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2610,6 +2620,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2713,6 +2724,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2876,10 +2888,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.collaborativeProjects.artifacts.html b/docs/dyn/aiplatform_v1beta1.projects.locations.collaborativeProjects.artifacts.html index e565ca87c1..9084478dbb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.collaborativeProjects.artifacts.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.collaborativeProjects.artifacts.html @@ -110,6 +110,7 @@

Method Details

"path": "A String", # Output only. Absolute path of the link file in the workspace, e.g. `/workspace/userdata/{artifact_id}.link.json` in a task or `/workspace/project/{artifact_id}.link.json` in a collaborative project. Always under `/workspace` and never contains `..`. Set by `ArtifactService.ListWorkspaceArtifacts`. `ArtifactService.AddArtifact` clears it from a request, so it is never written to the link file. "provider": "A String", # Required. The store that holds the entity. "sourceArtifactId": "A String", # Optional. The entity's ID in its store, unique within `provider`: a Drive file ID, a Jira issue ID, or, for OneDrive and SharePoint, whose item IDs are unique only within a drive, the drive ID and the drive item ID, e.g. "{drive-id}/{item-id}". At most 1024 characters. With `provider`, it identifies the entity: it names the link file and is the idempotency key for `AddArtifact`. When it is unset, `uri` takes its place, so two URIs of one entity, such as a Drive file's /view and /edit URIs, are two entities. + "title": "A String", # Optional. The entity's title in its store, e.g. a GitHub issue's title, an email's subject or a file's name. At most 1024 characters. "updateTime": "A String", # Output only. Last modification time of the link file at `path`, as `ArtifactService.ListWorkspaceArtifacts` read it. Not part of a link file. It is what tells two listings of one entity apart after the entity was updated in place. Such an update leaves every other field alone -- the entity keeps its `uri` and its `source_artifact_id`, so the link file keeps its name -- and it leaves the link file's bytes alone too, because a link file records WHICH entity is linked and not what state that entity is in. The time the file was rewritten is the only thing that moves. "uri": "A String", # Required. URI of the entity, e.g. "https://drive.google.com/file/d/FILE_ID/view". At most 2048 characters. }, @@ -163,12 +164,13 @@

Method Details

"path": "A String", # Output only. Absolute path of the link file in the workspace, e.g. `/workspace/userdata/{artifact_id}.link.json` in a task or `/workspace/project/{artifact_id}.link.json` in a collaborative project. Always under `/workspace` and never contains `..`. Set by `ArtifactService.ListWorkspaceArtifacts`. `ArtifactService.AddArtifact` clears it from a request, so it is never written to the link file. "provider": "A String", # Required. The store that holds the entity. "sourceArtifactId": "A String", # Optional. The entity's ID in its store, unique within `provider`: a Drive file ID, a Jira issue ID, or, for OneDrive and SharePoint, whose item IDs are unique only within a drive, the drive ID and the drive item ID, e.g. "{drive-id}/{item-id}". At most 1024 characters. With `provider`, it identifies the entity: it names the link file and is the idempotency key for `AddArtifact`. When it is unset, `uri` takes its place, so two URIs of one entity, such as a Drive file's /view and /edit URIs, are two entities. + "title": "A String", # Optional. The entity's title in its store, e.g. a GitHub issue's title, an email's subject or a file's name. At most 1024 characters. "updateTime": "A String", # Output only. Last modification time of the link file at `path`, as `ArtifactService.ListWorkspaceArtifacts` read it. Not part of a link file. It is what tells two listings of one entity apart after the entity was updated in place. Such an update leaves every other field alone -- the entity keeps its `uri` and its `source_artifact_id`, so the link file keeps its name -- and it leaves the link file's bytes alone too, because a link file records WHICH entity is linked and not what state that entity is in. The time the file was rewritten is the only thing that moves. "uri": "A String", # Required. URI of the entity, e.g. "https://drive.google.com/file/d/FILE_ID/view". At most 2048 characters. }, "taskArtifactFile": { # A file or directory in a task's workspace. # A file or directory in the workspace. "mimeType": "A String", # Output only. The detected media type. Empty for directories. - "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to DownloadTaskArtifact. + "path": "A String", # Output only. Absolute path in the task's sandbox, e.g. "/workspace/userdata/input.csv" or "/workspace/report.md". Always under "/workspace" and never contains "..". Can be passed as-is to ArtifactService.DownloadArtifact. "sizeBytes": "A String", # Output only. Size of the file in bytes. Zero for directories. "type": "A String", # Output only. Whether this entry is a file or a directory. "updateTime": "A String", # Output only. Last modification time of the file as it was read: the sandbox's when read from a running sandbox, otherwise the stored object's. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 286ee81bd9..2c5641d82f 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -229,6 +229,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -510,6 +511,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -673,10 +675,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -921,6 +923,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1202,6 +1205,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1365,10 +1369,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 8a02d51e56..bf9da73623 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -269,6 +269,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -404,6 +405,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -674,6 +676,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -821,10 +824,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2196,6 +2199,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2480,6 +2484,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2643,10 +2648,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2862,6 +2867,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5073,6 +5079,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5357,6 +5364,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5520,10 +5528,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5739,6 +5747,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index cccddff8cf..1aed8d3da5 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -258,10 +258,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -506,10 +506,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -696,6 +696,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -812,6 +813,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -975,10 +977,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1223,10 +1225,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1413,6 +1415,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1529,6 +1532,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1691,10 +1695,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1939,10 +1943,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2129,6 +2133,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2236,6 +2241,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2464,10 +2470,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2712,10 +2718,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2902,6 +2908,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3018,6 +3025,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3181,10 +3189,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3429,10 +3437,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3619,6 +3627,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3735,6 +3744,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3897,10 +3907,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4145,10 +4155,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4335,6 +4345,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4442,6 +4453,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4665,10 +4677,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4913,10 +4925,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5103,6 +5115,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5219,6 +5232,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5382,10 +5396,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5630,10 +5644,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5820,6 +5834,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5936,6 +5951,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6098,10 +6114,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6346,10 +6362,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6536,6 +6552,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6643,6 +6660,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6871,10 +6889,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7119,10 +7137,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7309,6 +7327,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7425,6 +7444,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7588,10 +7608,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7836,10 +7856,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8026,6 +8046,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8142,6 +8163,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8304,10 +8326,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8552,10 +8574,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -8742,6 +8764,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8849,6 +8872,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9115,10 +9139,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9363,10 +9387,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9553,6 +9577,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9669,6 +9694,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9832,10 +9858,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10080,10 +10106,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10270,6 +10296,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10386,6 +10413,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10548,10 +10576,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10796,10 +10824,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10986,6 +11014,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11093,6 +11122,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11321,10 +11351,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11569,10 +11599,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11759,6 +11789,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11875,6 +11906,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -12038,10 +12070,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12286,10 +12318,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12476,6 +12508,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -12592,6 +12625,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -12754,10 +12788,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13002,10 +13036,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13192,6 +13226,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -13299,6 +13334,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -13535,10 +13571,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13783,10 +13819,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13973,6 +14009,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14089,6 +14126,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14252,10 +14290,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14500,10 +14538,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14690,6 +14728,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14806,6 +14845,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14968,10 +15008,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15216,10 +15256,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15406,6 +15446,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15513,6 +15554,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15741,10 +15783,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15989,10 +16031,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -16179,6 +16221,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -16295,6 +16338,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -16458,10 +16502,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -16706,10 +16750,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -16896,6 +16940,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17012,6 +17057,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17174,10 +17220,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -17422,10 +17468,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -17612,6 +17658,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17719,6 +17766,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.revisions.html index 99a330d497..a2452a99dd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.revisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.revisions.html @@ -244,10 +244,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -492,10 +492,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -682,6 +682,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -798,6 +799,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -961,10 +963,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1209,10 +1211,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1399,6 +1401,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1515,6 +1518,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1677,10 +1681,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1925,10 +1929,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2115,6 +2119,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2222,6 +2227,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2450,10 +2456,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2698,10 +2704,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2888,6 +2894,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3004,6 +3011,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3167,10 +3175,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3415,10 +3423,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3605,6 +3613,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3721,6 +3730,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3883,10 +3893,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4131,10 +4141,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4321,6 +4331,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4428,6 +4439,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index 908389e6d2..8f7486ec04 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -3052,10 +3052,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3300,10 +3300,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3490,6 +3490,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3606,6 +3607,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3769,10 +3771,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4017,10 +4019,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4207,6 +4209,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4323,6 +4326,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4485,10 +4489,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4733,10 +4737,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4923,6 +4927,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5030,6 +5035,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5187,6 +5193,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5334,10 +5341,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5782,10 +5789,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6092,8 +6099,8 @@

Method Details

}, "codingAgent": { # A coding agent to run against the Harbor dataset. # The coding agent to run. "agent": "A String", # The coding agent to run, e.g. "antigravity-cli". - "agentModel": "A String", # Optional. The Vertex AI model the coding agent calls. Only Gemini based Vertex AI models are supported. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} - "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation settings of the model that the coding agent calls. If you do not set this field, the coding agent uses its default settings. Only `thinking_config.thinking_level` is supported. The valid levels are `MINIMAL`, `LOW`, `MEDIUM` and `HIGH`. `antigravity-cli` does not accept a level for Gemini 2.5 models. It accepts `MINIMAL` and `MEDIUM` only for Gemini Flash models. If you set a level that is not valid for the coding agent and the model, inference fails for the candidate. + "agentModel": "A String", # Required. The Vertex AI model the coding agent calls. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} The supported models include: * Publisher `google`: `gemini-4-argon` and `gemini-3.8-flash`, etc. * Publisher `anthropic`: `claude-opus-5-5` and `claude-sonnet-5-5`. To use a Claude model, enable it in Model Garden for the project of the evaluation run. If the model is not supported, the evaluation run is not created. The error lists the supported models. + "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Required. Generation settings of the model that the coding agent calls. For a model that does not accept a thinking level, set an empty `agent_model_config`. Only `thinking_config.thinking_level` is supported. The models `gemini-4-argon`, `gemini-3.8-flash`, `claude-opus-5-5`, and `claude-sonnet-5-5` accept `LOW`, `MEDIUM`, and `HIGH`. Set a level that the model accepts, or no level for a model that does not accept a level. Otherwise, the evaluation run is not created. The error lists the levels that the model accepts. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for audio transcription (speech recognition). "adaptationPhrases": [ # Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. @@ -9212,10 +9219,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9460,10 +9467,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9650,6 +9657,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9766,6 +9774,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9929,10 +9938,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10177,10 +10186,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10367,6 +10376,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10483,6 +10493,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10645,10 +10656,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10893,10 +10904,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11083,6 +11094,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11190,6 +11202,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11347,6 +11360,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11494,10 +11508,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11942,10 +11956,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -12252,8 +12266,8 @@

Method Details

}, "codingAgent": { # A coding agent to run against the Harbor dataset. # The coding agent to run. "agent": "A String", # The coding agent to run, e.g. "antigravity-cli". - "agentModel": "A String", # Optional. The Vertex AI model the coding agent calls. Only Gemini based Vertex AI models are supported. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} - "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation settings of the model that the coding agent calls. If you do not set this field, the coding agent uses its default settings. Only `thinking_config.thinking_level` is supported. The valid levels are `MINIMAL`, `LOW`, `MEDIUM` and `HIGH`. `antigravity-cli` does not accept a level for Gemini 2.5 models. It accepts `MINIMAL` and `MEDIUM` only for Gemini Flash models. If you set a level that is not valid for the coding agent and the model, inference fails for the candidate. + "agentModel": "A String", # Required. The Vertex AI model the coding agent calls. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} The supported models include: * Publisher `google`: `gemini-4-argon` and `gemini-3.8-flash`, etc. * Publisher `anthropic`: `claude-opus-5-5` and `claude-sonnet-5-5`. To use a Claude model, enable it in Model Garden for the project of the evaluation run. If the model is not supported, the evaluation run is not created. The error lists the supported models. + "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Required. Generation settings of the model that the coding agent calls. For a model that does not accept a thinking level, set an empty `agent_model_config`. Only `thinking_config.thinking_level` is supported. The models `gemini-4-argon`, `gemini-3.8-flash`, `claude-opus-5-5`, and `claude-sonnet-5-5` accept `LOW`, `MEDIUM`, and `HIGH`. Set a level that the model accepts, or no level for a model that does not accept a level. Otherwise, the evaluation run is not created. The error lists the levels that the model accepts. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for audio transcription (speech recognition). "adaptationPhrases": [ # Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. @@ -15414,10 +15428,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15662,10 +15676,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -15852,6 +15866,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15968,6 +15983,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -16131,10 +16147,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -16379,10 +16395,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -16569,6 +16585,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -16685,6 +16702,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -16847,10 +16865,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -17095,10 +17113,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -17285,6 +17303,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17392,6 +17411,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17549,6 +17569,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17696,10 +17717,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -18144,10 +18165,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -18454,8 +18475,8 @@

Method Details

}, "codingAgent": { # A coding agent to run against the Harbor dataset. # The coding agent to run. "agent": "A String", # The coding agent to run, e.g. "antigravity-cli". - "agentModel": "A String", # Optional. The Vertex AI model the coding agent calls. Only Gemini based Vertex AI models are supported. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} - "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation settings of the model that the coding agent calls. If you do not set this field, the coding agent uses its default settings. Only `thinking_config.thinking_level` is supported. The valid levels are `MINIMAL`, `LOW`, `MEDIUM` and `HIGH`. `antigravity-cli` does not accept a level for Gemini 2.5 models. It accepts `MINIMAL` and `MEDIUM` only for Gemini Flash models. If you set a level that is not valid for the coding agent and the model, inference fails for the candidate. + "agentModel": "A String", # Required. The Vertex AI model the coding agent calls. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} The supported models include: * Publisher `google`: `gemini-4-argon` and `gemini-3.8-flash`, etc. * Publisher `anthropic`: `claude-opus-5-5` and `claude-sonnet-5-5`. To use a Claude model, enable it in Model Garden for the project of the evaluation run. If the model is not supported, the evaluation run is not created. The error lists the supported models. + "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Required. Generation settings of the model that the coding agent calls. For a model that does not accept a thinking level, set an empty `agent_model_config`. Only `thinking_config.thinking_level` is supported. The models `gemini-4-argon`, `gemini-3.8-flash`, `claude-opus-5-5`, and `claude-sonnet-5-5` accept `LOW`, `MEDIUM`, and `HIGH`. Set a level that the model accepts, or no level for a model that does not accept a level. Otherwise, the evaluation run is not created. The error lists the levels that the model accepts. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for audio transcription (speech recognition). "adaptationPhrases": [ # Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. @@ -21587,10 +21608,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -21835,10 +21856,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -22025,6 +22046,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -22141,6 +22163,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -22304,10 +22327,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -22552,10 +22575,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -22742,6 +22765,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -22858,6 +22882,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -23020,10 +23045,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -23268,10 +23293,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -23458,6 +23483,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -23565,6 +23591,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -23722,6 +23749,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -23869,10 +23897,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -24317,10 +24345,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -24627,8 +24655,8 @@

Method Details

}, "codingAgent": { # A coding agent to run against the Harbor dataset. # The coding agent to run. "agent": "A String", # The coding agent to run, e.g. "antigravity-cli". - "agentModel": "A String", # Optional. The Vertex AI model the coding agent calls. Only Gemini based Vertex AI models are supported. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} - "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Optional. Generation settings of the model that the coding agent calls. If you do not set this field, the coding agent uses its default settings. Only `thinking_config.thinking_level` is supported. The valid levels are `MINIMAL`, `LOW`, `MEDIUM` and `HIGH`. `antigravity-cli` does not accept a level for Gemini 2.5 models. It accepts `MINIMAL` and `MEDIUM` only for Gemini Flash models. If you set a level that is not valid for the coding agent and the model, inference fails for the candidate. + "agentModel": "A String", # Required. The Vertex AI model the coding agent calls. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} The supported models include: * Publisher `google`: `gemini-4-argon` and `gemini-3.8-flash`, etc. * Publisher `anthropic`: `claude-opus-5-5` and `claude-sonnet-5-5`. To use a Claude model, enable it in Model Garden for the project of the evaluation run. If the model is not supported, the evaluation run is not created. The error lists the supported models. + "agentModelConfig": { # Configuration for content generation. This message contains all the parameters that control how the model generates content. It allows you to influence the randomness, length, and structure of the output. # Required. Generation settings of the model that the coding agent calls. For a model that does not accept a thinking level, set an empty `agent_model_config`. Only `thinking_config.thinking_level` is supported. The models `gemini-4-argon`, `gemini-3.8-flash`, `claude-opus-5-5`, and `claude-sonnet-5-5` accept `LOW`, `MEDIUM`, and `HIGH`. Set a level that the model accepts, or no level for a model that does not accept a level. Otherwise, the evaluation run is not created. The error lists the levels that the model accepts. "audioTimestamp": True or False, # Optional. If enabled, audio timestamps will be included in the request to the model. This can be useful for synchronizing audio with other modalities in the response. "audioTranscriptionConfig": { # Configuration for speech recognition (transcription). # Optional. Configuration for audio transcription (speech recognition). "adaptationPhrases": [ # Optional. Deprecated: Use `custom_vocabulary` instead. A list of phrases to bias the speech recognition model towards. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index e307374ef9..952a7240bd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -248,10 +248,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -526,10 +526,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -847,10 +847,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1159,10 +1159,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1508,10 +1508,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1805,10 +1805,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2084,10 +2084,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.revisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.revisions.html index 5bdab91b8e..69dafd3d28 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.revisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.revisions.html @@ -235,10 +235,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -587,10 +587,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -880,10 +880,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index 656fde77c4..c01aa09272 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -304,6 +304,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -401,6 +402,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -702,6 +704,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -831,6 +834,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -928,6 +932,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1056,6 +1061,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1153,6 +1159,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1279,6 +1286,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1376,6 +1384,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 590cbdfaa1..4259e5c36e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1212,6 +1212,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1320,6 +1321,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 136a9916cb..4b69290f87 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -607,10 +607,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -921,10 +921,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1152,6 +1152,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1298,6 +1299,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1430,6 +1432,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3402,6 +3405,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3557,10 +3561,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3757,6 +3761,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3912,10 +3917,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4108,6 +4113,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4208,6 +4214,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4358,10 +4365,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4606,10 +4613,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -4796,6 +4803,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4964,10 +4972,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5212,10 +5220,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -5402,6 +5410,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5518,6 +5527,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5621,6 +5631,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5722,6 +5733,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -5823,6 +5835,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7956,6 +7969,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8098,6 +8112,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8756,6 +8771,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -8911,10 +8927,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9104,6 +9120,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9719,10 +9736,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -9967,10 +9984,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10157,6 +10174,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10273,6 +10291,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10436,10 +10455,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10684,10 +10703,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10874,6 +10893,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10990,6 +11010,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11152,10 +11173,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11400,10 +11421,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -11590,6 +11611,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11697,6 +11719,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11868,6 +11891,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11992,6 +12016,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -12166,10 +12191,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 271ba2814e..44f9ac6de6 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -387,6 +387,18 @@

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -1316,6 +1328,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -3875,57 +4067,141 @@

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. - "isError": True or False, # Whether the code execution resulted in an error. - "result": "A String", # Required. The output of the code execution. - }, - "fileSearchResult": { # File Search result step. - }, - "functionResult": { # Result of a function tool call. - "isError": True or False, # Whether the tool call resulted in an error. - "name": "A String", # The name of the tool that was called. - "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. - "boolValue": True or False, # Represents a boolean value. - "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). - "audio": { # An audio content block. - "channels": 42, # The number of audio channels. - "data": "A String", # The audio content. - "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "sampleRate": 42, # The sample rate of the audio. - "uri": "A String", # The URI of the audio. - }, - "document": { # A document content block. - "data": "A String", # The document content. - "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "uri": "A String", # The URI of the document. - }, - "image": { # An image content block. - "data": "A String", # The image content. - "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. - "resolution": "A String", # The resolution of the media. - "uri": "A String", # The URI of the image. - }, - "text": { # A text content block. - "annotations": [ # Citation information for model-generated content. - { # Citation information for model-generated content. - "endIndex": 42, # End of the attributed segment, exclusive. - "fileCitation": { # A file citation annotation. # A file citation annotation. - "customMetadata": { # User provided metadata about the retrieved context. - "a_key": "", # Properties of the object. - }, - "documentUri": "A String", # The URI of the file. - "fileName": "A String", # The name of the file. - "mediaId": "A String", # Media ID in-case of image citations, if applicable. - "pageNumber": 42, # Page number of the cited document, if applicable. - "source": "A String", # Source attributed for a portion of the text. - }, - "placeCitation": { # A place citation annotation. # A place citation annotation. - "name": "A String", # Title of the place. - "placeId": "A String", # The ID of the place, in `places/{place_id}` format. - "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. - { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. - "reviewId": "A String", # The ID of the review snippet. - "title": "A String", # Title of the review. - "url": "A String", # A link that corresponds to the user review on Google Maps. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, + "isError": True or False, # Whether the code execution resulted in an error. + "result": "A String", # Required. The output of the code execution. + }, + "fileSearchResult": { # File Search result step. + }, + "functionResult": { # Result of a function tool call. + "isError": True or False, # Whether the tool call resulted in an error. + "name": "A String", # The name of the tool that was called. + "result": { # `Value` represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error. # Required. The result of the tool call. + "boolValue": True or False, # Represents a boolean value. + "contentValue": { # The content of the response. # Represents rich content (text, image, etc.). + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. }, ], "url": "A String", # URI reference of the place. @@ -4639,6 +4915,90 @@

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -6431,11 +6803,95 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -9004,6 +9556,90 @@

Method Details

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

Method Details

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

Method Details

"languageCodes": [ # Optional. BCP-47 language codes providing hints about the languages present in the audio. If omitted or empty, defaults to automatic language detection. "A String", ], + "modeConfig": { # Configuration for transcription mode. + "smart": { # Configuration for smart transcription mode. + "sourceText": "A String", # The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text. + }, + "verbatim": { # Configuration for verbatim transcription mode. + "diarizationMode": "A String", # Optional. Configures speaker diarization. Supported values: "speaker". + "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. + "A String", + ], + }, + }, + "modeEnum": "A String", "timestampGranularities": [ # Optional. The granularity of timestamps to include in the transcription output. Supported values: "word". If empty, no timestamps are generated. "A String", ], @@ -11553,6 +12285,90 @@

Method Details

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

Method Details

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

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html index 7ac493d560..38df0c8518 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html @@ -171,6 +171,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html index d04c87f1ad..1e1e7d6e82 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html @@ -323,6 +323,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html index b7043f9415..9426c2a51d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.analyzedSessions.html @@ -119,7 +119,7 @@

Method Details

"agentAggregates": [ # Aggregated statistics — exactly one entry per unique MonitoredAgent matched by the request. { # Contains aggregated statistics for one MonitoredAgent. "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent. - "agentResourceName": "A String", # The resource name or identifier of the agent. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agentResourceName": "A String", # The resource name or identifier of the agent. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`. For the format of each agent type, see AgentResource.agent. "agentStatus": "A String", # Output only. The enablement state of the MonitoredAgent (for example, ACTIVE, DISABLED, or ENABLING). "agentType": "A String", # Output only. The runtime the agent is hosted on (for example, `CLOUD_RUN_SERVICE`). `AGENT_TYPE_UNSPECIFIED` means the runtime is unknown to this service, which is distinct from `AGENT_TYPE_OTHER` (known, and not one of the enumerated Google Cloud runtimes). "anomalousSessionsCount": 42, # The number of anomalous (SESSION_STATE_FLAGGED) sessions for this agent. @@ -191,8 +191,8 @@

Method Details

view: string, Optional. Resource view to control which fields are returned. Allowed values ANALYZED_SESSION_VIEW_UNSPECIFIED - The default view: BASIC. - ANALYZED_SESSION_VIEW_BASIC - Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts). - ANALYZED_SESSION_VIEW_FULL - Full view includes all fields, including the detailed assessment. + ANALYZED_SESSION_VIEW_BASIC - Includes every `AnalyzedSession` field except `assessment`. + ANALYZED_SESSION_VIEW_FULL - Includes all fields, including the detailed `assessment`. AgentAnomalyDetectionService.ListAnalyzedSessions omits `assessment` in every view. To get it, call AgentAnomalyDetectionService.GetAnalyzedSession with this view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -203,7 +203,7 @@

Method Details

{ # Represents an analyzed session for a monitored agent. "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier. - "agentResourceName": "A String", # Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agentResourceName": "A String", # Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`. For the format of each agent type, see AgentResource.agent. "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown. "agentType": "A String", # Output only. The runtime that the agent which ran this session is hosted on (for example, `CLOUD_RUN_SERVICE`). `AGENT_TYPE_UNSPECIFIED` means the runtime is unknown to this service -- the agent is not enrolled as a `MonitoredAgent`, or was enrolled before its runtime was recorded. That is distinct from `AGENT_TYPE_OTHER`, which means the runtime is known and is not one of the enumerated Google Cloud runtimes. "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. @@ -226,7 +226,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the AnalyzedSession. "sessionId": "A String", # Output only. The session ID. "sessionState": "A String", # Output only. The state of the session. - "severities": { # Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only. + "severities": { # Output only. Map of the detectors that flagged this session, grouped by severity. The key is the string representation of `Severity`. Populated only for flagged sessions, in both views. In AgentAnomalyDetectionService.ListAnalyzedSessions responses, the map holds only the session's highest severity. "a_key": { # Breaks down anomalies by severity. "detectorDisplayNames": { # Output only. The display names of the customer-defined detectors in `detector_ids`, keyed by detector ID. A detector ID with no entry -- a Google-managed detector, or a customer-defined detector that has since been deleted -- has no display name. "a_key": "A String", @@ -255,8 +255,8 @@

Method Details

view: string, Optional. Resource view to control which fields are returned. Allowed values ANALYZED_SESSION_VIEW_UNSPECIFIED - The default view: BASIC. - ANALYZED_SESSION_VIEW_BASIC - Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts). - ANALYZED_SESSION_VIEW_FULL - Full view includes all fields, including the detailed assessment. + ANALYZED_SESSION_VIEW_BASIC - Includes every `AnalyzedSession` field except `assessment`. + ANALYZED_SESSION_VIEW_FULL - Includes all fields, including the detailed `assessment`. AgentAnomalyDetectionService.ListAnalyzedSessions omits `assessment` in every view. To get it, call AgentAnomalyDetectionService.GetAnalyzedSession with this view. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -269,7 +269,7 @@

Method Details

"analyzedSessions": [ # The list of analyzed sessions. { # Represents an analyzed session for a monitored agent. "agentDisplayName": "A String", # Output only. The human-readable display name of the MonitoredAgent that owns this session. May be empty when the session's agent is not enrolled as a MonitoredAgent; the `agent_resource_name` is always present and can be used as a fallback identifier. - "agentResourceName": "A String", # Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agentResourceName": "A String", # Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`. For the format of each agent type, see AgentResource.agent. "agentState": "A String", # Output only. The current enablement state of the MonitoredAgent that owns this session (for example, ACTIVE, DISABLED, or ENABLING). Defaults to ENABLEMENT_STATE_UNSPECIFIED when the agent is not enrolled or its state is unknown. "agentType": "A String", # Output only. The runtime that the agent which ran this session is hosted on (for example, `CLOUD_RUN_SERVICE`). `AGENT_TYPE_UNSPECIFIED` means the runtime is unknown to this service -- the agent is not enrolled as a `MonitoredAgent`, or was enrolled before its runtime was recorded. That is distinct from `AGENT_TYPE_OTHER`, which means the runtime is known and is not one of the enumerated Google Cloud runtimes. "assessment": { # Contains the detailed assessment for an analyzed session. # Output only. Overall security assessment. Populated only in FULL view. @@ -292,7 +292,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the AnalyzedSession. "sessionId": "A String", # Output only. The session ID. "sessionState": "A String", # Output only. The state of the session. - "severities": { # Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only. + "severities": { # Output only. Map of the detectors that flagged this session, grouped by severity. The key is the string representation of `Severity`. Populated only for flagged sessions, in both views. In AgentAnomalyDetectionService.ListAnalyzedSessions responses, the map holds only the session's highest severity. "a_key": { # Breaks down anomalies by severity. "detectorDisplayNames": { # Output only. The display names of the customer-defined detectors in `detector_ids`, keyed by detector ID. A detector ID with no entry -- a Google-managed detector, or a customer-defined detector that has since been deleted -- has no display name. "a_key": "A String", diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html index 8715419d88..9e2e92b2c4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.monitoredAgents.html @@ -245,7 +245,7 @@

Method Details

{ # Represents a monitored agent in a specific Location. "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored. - "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `//aiplatform.googleapis.com/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`: the full resource name of the Cloud Run service, `//run.googleapis.com/projects/{project}/locations/{location}/services/{service}` * `GKE_WORKLOAD`: the full resource name of the Google Kubernetes Engine cluster followed by the agent's OpenTelemetry `service.name`, `//container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/{service}`. For a zonal cluster, `zones/{zone}` replaces `locations/{location}`. Some names end in `k8s/namespaces/{namespace}/apps/deployments/{deployment}` instead of `{service}`. * `GCE_INSTANCE`: the full resource name of the Compute Engine instance followed by the agent's OpenTelemetry `service.name`, `//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}/{service}`, where `{instance}` is the numeric instance ID. * `AGENT_TYPE_OTHER`: a stable identifier for the agent, such as the full resource name of its runtime or its OpenTelemetry `service.name`. "agentFramework": "A String", # Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`. "agentType": "A String", # Required. The runtime type of the agent. "location": "A String", # Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`). @@ -280,7 +280,7 @@

Method Details

"monitoredAgents": [ # A list of MonitoredAgents that matches the specified filter in the request. { # Represents a monitored agent in a specific Location. "agentResource": { # Defines the identity of an agent being monitored. # Required. The configuration for the agent being monitored. - "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent. + "agent": "A String", # Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `//aiplatform.googleapis.com/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`: the full resource name of the Cloud Run service, `//run.googleapis.com/projects/{project}/locations/{location}/services/{service}` * `GKE_WORKLOAD`: the full resource name of the Google Kubernetes Engine cluster followed by the agent's OpenTelemetry `service.name`, `//container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/{service}`. For a zonal cluster, `zones/{zone}` replaces `locations/{location}`. Some names end in `k8s/namespaces/{namespace}/apps/deployments/{deployment}` instead of `{service}`. * `GCE_INSTANCE`: the full resource name of the Compute Engine instance followed by the agent's OpenTelemetry `service.name`, `//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}/{service}`, where `{instance}` is the numeric instance ID. * `AGENT_TYPE_OTHER`: a stable identifier for the agent, such as the full resource name of its runtime or its OpenTelemetry `service.name`. "agentFramework": "A String", # Optional. The framework used to build the agent, orthogonal to the runtime `agent_type`. "agentType": "A String", # Required. The runtime type of the agent. "location": "A String", # Output only. The Google Cloud location (region) of the agent resource (for example, `us-central1`). diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 6fa2007475..921c1761c7 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -206,6 +206,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -384,6 +385,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -519,6 +521,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -789,6 +792,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -936,10 +940,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1158,6 +1162,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1452,6 +1457,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1736,6 +1742,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1899,10 +1906,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2118,6 +2125,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2829,6 +2837,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3113,6 +3122,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3276,10 +3286,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3495,6 +3505,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. 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 41f8b3cc78..564fe49177 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html @@ -299,6 +299,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -403,6 +404,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -508,6 +510,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html index f36450fcf9..340c4d2277 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html @@ -302,6 +302,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -406,6 +407,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -511,6 +513,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -717,6 +720,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -850,6 +854,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1036,6 +1041,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1169,6 +1175,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1384,6 +1391,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1517,6 +1525,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1715,6 +1724,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1848,6 +1858,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html index 054b4e1644..fb0b92f3ce 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html @@ -330,6 +330,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -692,6 +693,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index b3ac5a4e54..2a66e32bce 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -334,6 +334,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -499,7 +500,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -990,7 +992,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1412,7 +1415,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1804,7 +1808,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -562,6 +563,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html index a5622c7d90..6182a865be 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.runtimeRevisions.html @@ -169,7 +169,7 @@

Method Details

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

Method Details

}, "agentFramework": "A String", # Optional. The OSS agent framework used to develop the agent. Currently supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", "custom". "buildSpec": { # Specification for building container image. # Optional. Configuration for building container image. - "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` + "serviceAccount": "A String", # Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for private pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com` "workerPool": "A String", # Optional. Identifier. The resource name of the Cloud Build WorkerPool to use for the build. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` }, "classMethods": [ # Optional. Declarations for object class methods in OpenAPI specification format. 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 92cd68878e..daf4ac9a69 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -188,6 +188,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index b4e86bbb70..6867fc11de 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -199,6 +199,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tasks.html index 95a54b793f..e16944d020 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tasks.html @@ -394,7 +394,7 @@

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -826,6 +826,90 @@

Method Details

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

Method Details

"hitlConfig": { # Session-level HITL (human-in-the-loop) configuration. Namespaces every HITL knob that a client may set at task creation, so new settings (per-tool overrides, timeout, allowed reviewers) can land without burning more top-level TaskSpec tags. `approval_mode` carries the wire default as its own `APPROVAL_MODE_UNSPECIFIED` enum value, which the server treats as `APPROVAL_MODE_ASK` (standard HITL, always prompt a human). That is also the pre-change behavior for every existing task. # Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults. "approvalMode": "A String", # Optional. Immutable. How the client wants elicitations on this task approved. Unset (or APPROVAL_MODE_UNSPECIFIED) is treated as APPROVAL_MODE_ASK. }, - "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. + "inputs": [ # Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace. { # A step in the interaction. "modelOutput": { # Output generated by the model. "content": [ @@ -2057,6 +2141,90 @@

Method Details

"toolResult": { # Tool result step. "callId": "A String", # Required. ID to match the ID from the function call block. "codeExecutionResult": { # Code execution result step. + "content": { # A list of Content. # Multimodal output of the code execution. + "contents": [ # The contents of the list. + { # The content of the response. + "audio": { # An audio content block. + "channels": 42, # The number of audio channels. + "data": "A String", # The audio content. + "mimeTypeString": "A String", # Flexible MIME type string of the audio, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "sampleRate": 42, # The sample rate of the audio. + "uri": "A String", # The URI of the audio. + }, + "document": { # A document content block. + "data": "A String", # The document content. + "mimeTypeString": "A String", # Flexible MIME type string of the document, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "uri": "A String", # The URI of the document. + }, + "image": { # An image content block. + "data": "A String", # The image content. + "mimeTypeString": "A String", # Flexible MIME type string of the image, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the image. + }, + "text": { # A text content block. + "annotations": [ # Citation information for model-generated content. + { # Citation information for model-generated content. + "endIndex": 42, # End of the attributed segment, exclusive. + "fileCitation": { # A file citation annotation. # A file citation annotation. + "customMetadata": { # User provided metadata about the retrieved context. + "a_key": "", # Properties of the object. + }, + "documentUri": "A String", # The URI of the file. + "fileName": "A String", # The name of the file. + "mediaId": "A String", # Media ID in-case of image citations, if applicable. + "pageNumber": 42, # Page number of the cited document, if applicable. + "source": "A String", # Source attributed for a portion of the text. + }, + "placeCitation": { # A place citation annotation. # A place citation annotation. + "name": "A String", # Title of the place. + "placeId": "A String", # The ID of the place, in `places/{place_id}` format. + "reviewSnippets": [ # Snippets of reviews that are used to generate answers about the features of a given place in Google Maps. + { # Encapsulates a snippet of a user review that answers a question about the features of a specific place in Google Maps. + "reviewId": "A String", # The ID of the review snippet. + "title": "A String", # Title of the review. + "url": "A String", # A link that corresponds to the user review on Google Maps. + }, + ], + "url": "A String", # URI reference of the place. + }, + "speechMetadata": { # Speech annotation for text content. # Speech annotation for text content. + "speaker": "A String", # The speaker to associate with this turn. + "style": "A String", # Style instruction for the speech synthesis. + }, + "startIndex": 42, # Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes. + "urlCitation": { # A URL citation annotation. # NOTE: We use these instead of the Citation message for historical reasons. A URL citation annotation. + "title": "A String", # The title of the URL. + "url": "A String", # The URL. + }, + "wordInfo": { # Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution. # Word-level ASR annotation with timing and speaker info. + "endOffset": "A String", # End offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "speaker": "A String", # Optional. Speaker label for this word (e.g. "spk_1", "spk_2"). Present when diarization_mode is set in TranscriptionConfig. + "startOffset": "A String", # Start offset in time of the word relative to the start of the audio. Present when timestamp_granularities contains "word". + "text": "A String", # The transcribed word. + }, + }, + ], + "text": "A String", # Required. The text content. + }, + "video": { # A video content block. + "data": "A String", # The video content. + "mimeTypeString": "A String", # Flexible MIME type string of the video, superseding mime_type = 1. Note: Bespoke logic in the GAOS parser/serializer maps this to the "mime_type" JSON key. + "name": "A String", # A user-defined name for this content block. Can be referenced by the model in the final response. + "processingConfig": { + "static": { + "endOffset": "A String", # Optional. Segment end time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "30s". Must be non-negative and greater than `start_offset` if `start_offset` is set. + "fps": 3.14, # Optional. Video frame-rate sampling density. + "startOffset": "A String", # Optional. Segment start time. Specified as a decimal number of seconds followed by an 's' suffix, e.g., "10.5s". Must be non-negative. + }, + }, + "processingType": "A String", + "resolution": "A String", # The resolution of the media. + "uri": "A String", # The URI of the video. + }, + }, + ], + }, "isError": True or False, # Whether the code execution resulted in an error. "result": "A String", # Required. The output of the code execution. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index c205e046c6..826eacaf9a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -272,6 +272,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "omniLoraTuningSpec": { # Tuning Spec for Omni LoRA Model Tuning. # Optional. Tuning Spec for Omni LoRA Tuning. + "hyperParameters": { # Hyperparameters for Omni LoRA tuning. # Optional. Hyperparameters for Omni LoRA tuning. + "adapterSize": "A String", # Optional. Adapter size for Omni LoRA tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningTask": "A String", # Optional. The tuning task for Omni LoRA tuning. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file. + }, "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. @@ -2236,6 +2245,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2334,6 +2344,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2481,10 +2492,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2679,6 +2690,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2870,6 +2882,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2968,6 +2981,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3125,6 +3139,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3223,6 +3238,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3370,10 +3386,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3568,6 +3584,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3726,6 +3743,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3977,6 +3995,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "omniLoraTuningSpec": { # Tuning Spec for Omni LoRA Model Tuning. # Optional. Tuning Spec for Omni LoRA Tuning. + "hyperParameters": { # Hyperparameters for Omni LoRA tuning. # Optional. Hyperparameters for Omni LoRA tuning. + "adapterSize": "A String", # Optional. Adapter size for Omni LoRA tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningTask": "A String", # Optional. The tuning task for Omni LoRA tuning. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file. + }, "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. @@ -5941,6 +5968,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6039,6 +6067,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6186,10 +6215,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -6384,6 +6413,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6575,6 +6605,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6673,6 +6704,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6830,6 +6862,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6928,6 +6961,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7075,10 +7109,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7273,6 +7307,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7431,6 +7466,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7689,6 +7725,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "omniLoraTuningSpec": { # Tuning Spec for Omni LoRA Model Tuning. # Optional. Tuning Spec for Omni LoRA Tuning. + "hyperParameters": { # Hyperparameters for Omni LoRA tuning. # Optional. Hyperparameters for Omni LoRA tuning. + "adapterSize": "A String", # Optional. Adapter size for Omni LoRA tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningTask": "A String", # Optional. The tuning task for Omni LoRA tuning. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file. + }, "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. @@ -9653,6 +9698,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9751,6 +9797,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -9898,10 +9945,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10096,6 +10143,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10287,6 +10335,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10385,6 +10434,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10542,6 +10592,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10640,6 +10691,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -10787,10 +10839,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -10985,6 +11037,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11143,6 +11196,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -11407,6 +11461,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "omniLoraTuningSpec": { # Tuning Spec for Omni LoRA Model Tuning. # Optional. Tuning Spec for Omni LoRA Tuning. + "hyperParameters": { # Hyperparameters for Omni LoRA tuning. # Optional. Hyperparameters for Omni LoRA tuning. + "adapterSize": "A String", # Optional. Adapter size for Omni LoRA tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningTask": "A String", # Optional. The tuning task for Omni LoRA tuning. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file. + }, "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. @@ -13371,6 +13434,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -13469,6 +13533,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -13616,10 +13681,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -13814,6 +13879,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14005,6 +14071,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14103,6 +14170,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14260,6 +14328,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14358,6 +14427,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14505,10 +14575,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -14703,6 +14773,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -14861,6 +14932,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15069,6 +15141,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15175,6 +15248,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -15408,6 +15482,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Output only. Identifier. Resource name of a TuningJob. Format: `projects/{project}/locations/{location}/tuningJobs/{tuning_job}` + "omniLoraTuningSpec": { # Tuning Spec for Omni LoRA Model Tuning. # Optional. Tuning Spec for Omni LoRA Tuning. + "hyperParameters": { # Hyperparameters for Omni LoRA tuning. # Optional. Hyperparameters for Omni LoRA tuning. + "adapterSize": "A String", # Optional. Adapter size for Omni LoRA tuning. + "epochCount": "A String", # Optional. Number of complete passes the model makes over the entire training dataset during training. + "learningRateMultiplier": 3.14, # Optional. Multiplier for adjusting the default learning rate. + "tuningTask": "A String", # Optional. The tuning task for Omni LoRA tuning. + }, + "trainingDatasetUri": "A String", # Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file. + }, "outputUri": "A String", # Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models. "partnerModelTuningSpec": { # Tuning spec for Partner models. # Tuning Spec for open sourced and third party Partner models. "hyperParameters": { # Hyperparameters for tuning. The accepted hyper_parameters and their valid range of values will differ depending on the base model. @@ -17372,6 +17455,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17470,6 +17554,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -17617,10 +17702,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -17815,6 +17900,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18006,6 +18092,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18104,6 +18191,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18261,6 +18349,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18359,6 +18448,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18506,10 +18596,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -18704,6 +18794,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -18862,6 +18953,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -19310,6 +19402,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -19408,6 +19501,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -19555,10 +19649,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -19745,6 +19839,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 3518155eaf..bf47cb389f 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -186,6 +186,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -321,6 +322,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -591,6 +593,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -738,10 +741,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1003,6 +1006,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1287,6 +1291,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1450,10 +1455,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -1669,6 +1674,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3298,6 +3304,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3582,6 +3589,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3745,10 +3753,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3964,6 +3972,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index c199c4760b..6f18903e5d 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -319,6 +319,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -484,7 +485,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -976,7 +978,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1363,7 +1366,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1755,7 +1759,7 @@

Method Details

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

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -562,6 +563,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index d0aebe32e9..600c297438 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -188,6 +188,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 850d8dbe80..221b6989da 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -196,6 +196,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index b536c933bb..f9a46e72dc 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -1645,6 +1645,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -1800,10 +1801,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2000,6 +2001,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2155,10 +2157,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2351,6 +2353,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2451,6 +2454,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -2601,10 +2605,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -2849,10 +2853,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3039,6 +3043,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3207,10 +3212,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3455,10 +3460,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -3645,6 +3650,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3761,6 +3767,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3864,6 +3871,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -3965,6 +3973,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -4066,6 +4075,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6199,6 +6209,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6341,6 +6352,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -6998,6 +7010,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. @@ -7153,10 +7166,10 @@

Method Details

], "googleMaps": { # Tool to retrieve public maps data for grounding, powered by Google. # Optional. GoogleMaps tool type. Tool to support Google Maps in Model. "enableWidget": True or False, # Optional. Deprecated: The Google Maps contextual widget behavior in Grounding with Google Maps is being deprecated; this field is planned for removal and no longer has any effect once removed. If true, include the widget context token in the response. - "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset. + "groundingTypes": { # Defines the types of Google Maps grounding that can be enabled and their configurations. # Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing. "places": { # Grounding with Google Maps Places data (e.g. QueryPlaces). This is the default Google Maps grounding type when no other type is specified. # Optional. Enables grounding with Google Maps Places. This is the default grounding type when no `GroundingTypes` are specified. }, - "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). + "routing": { # Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified. # Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified. }, }, }, @@ -7346,6 +7359,7 @@

Method Details

"displayName": "A String", # Optional. Display name of the blob. Used to provide a label or filename to distinguish blobs. This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled. "mimeType": "A String", # Required. The IANA standard MIME type of the source data. }, + "mediaProcessing": "A String", # Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field. }, ], "response": { # Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output. diff --git a/docs/dyn/androiddeviceprovisioning_v1.customers.html b/docs/dyn/androiddeviceprovisioning_v1.customers.html index 0c64b4e38f..a261f58ea9 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.customers.html +++ b/docs/dyn/androiddeviceprovisioning_v1.customers.html @@ -133,7 +133,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html b/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html index daae59fa05..898c8596b1 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html +++ b/docs/dyn/androiddeviceprovisioning_v1.partners.customers.html @@ -114,7 +114,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", @@ -144,7 +144,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", @@ -184,7 +184,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html index 635d094aa3..882bf3e8fd 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html +++ b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.customers.html @@ -119,7 +119,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", diff --git a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html index 2c41ed95f1..a6a9437b0f 100644 --- a/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html +++ b/docs/dyn/androiddeviceprovisioning_v1.partners.vendors.html @@ -126,7 +126,7 @@

Method Details

"A String", ], }, - "languageCode": "A String", # Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi) + "languageCode": "A String", # Input only. Deprecated: This field is no longer supported and is ignored by the server. "name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server. "ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Owners share the same access as admins but can also add, delete, and edit your organization's portal users. "A String", diff --git a/docs/dyn/androidpublisher_v3.edits.images.html b/docs/dyn/androidpublisher_v3.edits.images.html index daf7beedc3..7be1de5714 100644 --- a/docs/dyn/androidpublisher_v3.edits.images.html +++ b/docs/dyn/androidpublisher_v3.edits.images.html @@ -223,7 +223,7 @@

Method Details

tvBanner - TV banner. aiGeneratedState: string, Optional. Whether the image was generated by AI. Attested by the developer. Allowed values - aiGeneratedStateUnspecified - Catch-all for unrecognized enum values. See go/protodosdonts. + aiGeneratedStateUnspecified - Unspecified AI generated state. aiGeneratedStateNotAiGenerated - The content is not generated by AI. aiGeneratedStateAiGeneratedDeveloperAttested - The content is generated by AI and attested by the developer. media_body: string, The filename of the media request body, or an instance of a MediaUpload object. diff --git a/docs/dyn/androidpublisher_v3.inappproducts.html b/docs/dyn/androidpublisher_v3.inappproducts.html index 29d8c0482e..7c32dc0875 100644 --- a/docs/dyn/androidpublisher_v3.inappproducts.html +++ b/docs/dyn/androidpublisher_v3.inappproducts.html @@ -171,7 +171,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -183,7 +183,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -200,7 +200,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -254,7 +254,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -266,7 +266,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -283,7 +283,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -336,7 +336,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -348,7 +348,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -365,7 +365,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -444,7 +444,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -456,7 +456,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -473,7 +473,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -520,7 +520,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -532,7 +532,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -549,7 +549,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -595,7 +595,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -607,7 +607,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -624,7 +624,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -681,7 +681,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -693,7 +693,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -710,7 +710,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -770,7 +770,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -782,7 +782,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -799,7 +799,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -850,7 +850,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -862,7 +862,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -879,7 +879,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -927,7 +927,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -939,7 +939,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -956,7 +956,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -1008,7 +1008,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -1020,7 +1020,7 @@

Method Details

}, }, "packageName": "A String", # Package name of the parent app. - "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2. + "prices": { # Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2. "a_key": { # Definition of a price, i.e. currency and units. "currency": "A String", # 3 letter Currency code, as defined by ISO 4217. See java/com/google/common/money/CurrencyCode.java "priceMicros": "A String", # Price in 1/million of the currency base unit, represented as a string. @@ -1037,7 +1037,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html index 340bd9c0e3..68f2dc5542 100644 --- a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html +++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.html @@ -198,7 +198,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -215,7 +215,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -225,13 +225,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -304,7 +304,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -321,7 +321,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -331,13 +331,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -410,7 +410,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -427,7 +427,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -437,13 +437,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -541,7 +541,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -558,7 +558,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -568,13 +568,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -650,7 +650,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -667,7 +667,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -677,13 +677,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -766,7 +766,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -783,7 +783,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -793,13 +793,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, @@ -871,7 +871,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -888,7 +888,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -898,13 +898,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html index c4ef4f2b81..2d4e43fc66 100644 --- a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html +++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.html @@ -205,7 +205,7 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". }, ], "rentOption": { # A purchase option that can be rented. # A purchase option that can be rented. @@ -222,7 +222,7 @@

Method Details

"version": "A String", # Required. A string representing the version of available regions being used for the specified resource. Regional prices and latest supported version for the resource have to be specified according to the information published in [this article](https://support.google.com/googleplay/android-developer/answer/10532353). Each time the supported locations substantially change, the version will be incremented. Using this field will ensure that creating and updating the resource with an older region's version and set of regional prices and currencies will succeed even though a new version is available. }, "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this one-time product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -232,13 +232,13 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionalTaxConfigs": [ # Regional tax configuration. { # Details about taxation in a given geographical region. "eligibleForStreamingServiceTaxRate": True or False, # You must tell us if your app contains streaming products to correctly charge US state and local sales tax. Field only supported in the United States. - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". "streamingTaxType": "A String", # To collect communications or amusement taxes in the United States, choose the appropriate tax category. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498#streaming_tax). "taxTier": "A String", # Tax tier to specify reduced tax rate. Developers who sell digital news, magazines, newspapers, books, or audiobooks in various regions may be eligible for reduced tax rates. [Learn more](https://support.google.com/googleplay/android-developer/answer/10463498). }, diff --git a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html index 25b0d3b9a5..dd94c3833d 100644 --- a/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html +++ b/docs/dyn/androidpublisher_v3.monetization.onetimeproducts.purchaseOptions.offers.html @@ -167,7 +167,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -274,7 +274,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -337,7 +337,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -398,7 +398,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -494,7 +494,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -569,7 +569,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -647,7 +647,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], @@ -713,7 +713,7 @@

Method Details

"availability": "A String", # Required. The availability for this region. "noOverride": { # Options for one-time product offers without a regional price override. # The price defined in the purchase option for this region will be used. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., "US". "relativeDiscount": 3.14, # The percentage discount subtracted from the purchase option price, specified as a fraction strictly larger than `0` and strictly smaller than `1`. For example, a value of `0.8` represents an 80% discount, meaning that if the purchase option price is $100, the offer price will be $20. The resulting price will be rounded to the nearest billable unit (e.g. cents for USD). The relative discount is considered invalid if the discounted price ends up being smaller than the minimum price allowed in this region. }, ], diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html index 3cde316e92..4960e43d63 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.html @@ -180,10 +180,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -199,7 +203,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -210,7 +214,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -245,7 +249,7 @@

Method Details

{ # Configuration for migration of a legacy price cohort. "oldestAllowedPriceVersionTime": "A String", # Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type. "priceIncreaseType": "A String", # Optional. The requested type of price increase - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations. @@ -363,10 +367,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -382,7 +390,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -393,7 +401,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -493,10 +501,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -512,7 +524,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -523,7 +535,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -572,7 +584,7 @@

Method Details

{ # Configuration for migration of a legacy price cohort. "oldestAllowedPriceVersionTime": "A String", # Required. Subscribers in all legacy price cohorts before this time will be migrated to the current price. Subscribers in any newer price cohorts are unaffected. Affected subscribers will receive one or more notifications from Google Play about the price change. Price decreases occur at the subscriber's next billing date. Price increases occur at the subscriber's next billing date following a notification period that varies by region and price increase type. "priceIncreaseType": "A String", # Optional. The requested type of price increase - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "regionsVersion": { # The version of the available regions being used for the specified resource. # Required. The version of the available regions being used for the regional_price_migrations. diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html index 43dca22c6c..1fc69fd5da 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.basePlans.offers.html @@ -208,7 +208,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -338,7 +338,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -457,7 +457,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -568,7 +568,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -710,7 +710,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -826,7 +826,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -933,7 +933,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -1059,7 +1059,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -1190,7 +1190,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -1309,7 +1309,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -1435,7 +1435,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. @@ -1548,7 +1548,7 @@

Method Details

"regionalConfigs": [ # Required. The region-specific configuration of this offer. Must contain at least one entry. { # Configuration for a subscription offer in a single region. "newSubscriberAvailability": True or False, # Whether the subscription offer in the specified region is available for new subscribers. Existing subscribers will not have their subscription cancelled if this value is set to false. If not specified, this will default to false. - "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The current state of this offer. Can be changed using Activate and Deactivate actions. NB: the base plan state supersedes this state, so an active offer may not be available if the base plan is not active. diff --git a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html index ad0cc65a4e..fa454247d0 100644 --- a/docs/dyn/androidpublisher_v3.monetization.subscriptions.html +++ b/docs/dyn/androidpublisher_v3.monetization.subscriptions.html @@ -184,10 +184,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -203,7 +207,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -214,7 +218,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -298,10 +302,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -317,7 +325,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -328,7 +336,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -414,10 +422,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -433,7 +445,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -444,7 +456,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -524,10 +536,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -543,7 +559,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -554,7 +570,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -637,10 +653,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -656,7 +676,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -667,7 +687,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -743,10 +763,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -762,7 +786,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -773,7 +797,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -869,10 +893,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -888,7 +916,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -899,7 +927,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -986,10 +1014,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -1005,7 +1037,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -1016,7 +1048,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -1109,10 +1141,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -1128,7 +1164,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -1139,7 +1175,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". @@ -1221,10 +1257,14 @@

Method Details

"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. }, - "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "state": "A String", # Output only. The state of the base plan, i.e. whether it's active. Draft and inactive base plans can be activated or deleted. Active base plans can be made inactive. Inactive base plans can be canceled. This field cannot be changed by updating the resource. Use the dedicated endpoints instead. + "transitionTargetConfig": { # Configuration for a transition target base plan. # Transition target base plan information when this base plan has a transition plan. + "basePlanId": "A String", # Required. The ID of the transition target base plan. + "productId": "A String", # Required. The ID of the parent subscription this transition target base plan belongs to. + }, }, ], "listings": [ # Required. List of localized listings for this subscription. Must contain at least an entry for the default language of the parent app. @@ -1240,7 +1280,7 @@

Method Details

"packageName": "A String", # Immutable. Package name of the parent app. "productId": "A String", # Immutable. Unique product ID of the product. Unique within the parent app. Product IDs must be composed of lower-case letters (a-z), numbers (0-9), underscores (_) and dots (.). It must start with a lower-case letter or number, and be between 1 and 40 (inclusive) characters in length. "restrictedPaymentCountries": { # Countries where the purchase of this product is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. # Optional. Countries where the purchase of this subscription is restricted to payment methods registered in the same country. If empty, no payment location restrictions are imposed. - "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. "US". + "regionCodes": [ # Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. "US". "A String", ], }, @@ -1251,7 +1291,7 @@

Method Details

"regionalProductAgeRatingInfos": [ # Regional age rating information. Currently this field is only supported for region code `US`. { # Details about the age rating for a specific geographic region. "productAgeRatingTier": "A String", # The age rating tier of a product for the given region. - "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-2, e.g. "US". + "regionCode": "A String", # Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. "US". }, ], "taxRateInfoByRegionCode": { # A mapping from region code to tax rate details. The keys are region codes as defined by Unicode's "CLDR". diff --git a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html index 60f27d5bda..e5e02ef30d 100644 --- a/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html +++ b/docs/dyn/androidpublisher_v3.purchases.subscriptionsv2.html @@ -77,6 +77,9 @@

Instance Methods

cancel(packageName, token, body=None, x__xgafv=None)

Cancel a subscription purchase for the user.

+

+ cancelplantransition(packageName, token, body=None, x__xgafv=None)

+

Cancel a plan transition for a subscription.

close()

Close httplib2 connections.

@@ -89,6 +92,9 @@

Instance Methods

revoke(packageName, token, body=None, x__xgafv=None)

Revoke a subscription purchase for the user.

+

+ scheduleplantransition(packageName, token, body=None, x__xgafv=None)

+

Schedule a plan transition for a subscription.

Method Details

cancel(packageName, token, body=None, x__xgafv=None) @@ -118,6 +124,33 @@

Method Details

}
+
+ cancelplantransition(packageName, token, body=None, x__xgafv=None) +
Cancel a plan transition for a subscription.
+
+Args:
+  packageName: string, Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
+  token: string, Required. The token provided to the user's device when the subscription was purchased. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the purchases.subscriptionsv2.cancelplantransition API.
+  "etag": "A String", # If set, the API will fail if the etag does not match the latest etag for this subscription. The etag is retrieved from purchases.subscriptionsv2.get: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get
+  "productId": "A String", # Required. The subscription product (for example, 'premium_plan') for which an in process plan transition should be canceled.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the purchases.subscriptionsv2.cancelplantransition API.
+}
+
+
close()
Close httplib2 connections.
@@ -214,6 +247,19 @@

Method Details

"remainingCommittedPaymentsCount": 42, # Total number of committed payments remaining to be paid for in this renewal cycle. "subsequentCommittedPaymentsCount": 42, # Total number of payments the user will be committed for after each commitment period. Empty means the installment plan will fall back to a normal auto-renew subscription after initial commitment. }, + "planTransitionDetails": { # Information related to a plan transition. # The information of the associated plan transition. Will be present only if this plan has a transition plan associated with it and will only include the latest transition details associated with the item. + "basePlanId": "A String", # [Required] The base plan ID to which this plan would be transitioned. + "productId": "A String", # [Required] The product ID to which this plan would be transitioned, (for example, 'monthly001'). + "transitionInfo": { # Information related to a scheduled plan transition. # Additional info about the scheduled plan transition. Will be present only if a plan transition has been scheduled. + "expectedTransitionTime": "A String", # The current expected time at which the plan may be transitioned. This is subject to change (to a future time) due to cases where the renewal time shifts like pause and account hold. + "price": { # Represents an amount of money with its currency type. # The default base plan price to which the plan will be transitioned. + "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. + }, + "transitionState": "A String", # Output only. [Required] The current state of the transition. + }, + }, "priceChangeDetails": { # Price change related information of a subscription item. # The information of the last price change for the item since subscription signup. "expectedNewPriceChargeTime": "A String", # The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect. "newPrice": { # Represents an amount of money with its currency type. # New recurring price for the subscription item. @@ -349,4 +395,49 @@

Method Details

}
+
+ scheduleplantransition(packageName, token, body=None, x__xgafv=None) +
Schedule a plan transition for a subscription.
+
+Args:
+  packageName: string, Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing'). (required)
+  token: string, Required. The token provided to the user's device when the subscription was purchased. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for the purchases.subscriptionsv2.schedulePlanTransition API.
+  "definiteTransition": { # Used to indicate that the plan transition is definite. # When using this mode, the user's transition to the new plan is definite, and cannot be canceled.
+  },
+  "earliestTransitionEffectiveTime": "A String", # Required. The earliest time at which the plan transition may take effect. The actual transition will take place at the time of renewal on or after this time.
+  "etag": "A String", # If set, the API will fail if the etag does not match the latest etag for this subscription. The etag is retrieved from purchases.subscriptionsv2.get: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get
+  "productId": "A String", # Required. The subscription product (for example, 'premium_plan') for which the transition must be scheduled.
+  "tentativeTransition": { # Used to indicate that the plan transition is tentative. # When using this mode, the user's transition to the new plan is tentative, and can be canceled.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the purchases.subscriptionsv2.schedulePlanTransition API.
+  "planTransitionDetails": { # Information related to a plan transition. # The plan transition details of the subscription item.
+    "basePlanId": "A String", # [Required] The base plan ID to which this plan would be transitioned.
+    "productId": "A String", # [Required] The product ID to which this plan would be transitioned, (for example, 'monthly001').
+    "transitionInfo": { # Information related to a scheduled plan transition. # Additional info about the scheduled plan transition. Will be present only if a plan transition has been scheduled.
+      "expectedTransitionTime": "A String", # The current expected time at which the plan may be transitioned. This is subject to change (to a future time) due to cases where the renewal time shifts like pause and account hold.
+      "price": { # Represents an amount of money with its currency type. # The default base plan price to which the plan will be transitioned.
+        "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.
+      },
+      "transitionState": "A String", # Output only. [Required] The current state of the transition.
+    },
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/apikeys_v2.projects.locations.keys.html b/docs/dyn/apikeys_v2.projects.locations.keys.html index a3e75fbcad..f7895b1860 100644 --- a/docs/dyn/apikeys_v2.projects.locations.keys.html +++ b/docs/dyn/apikeys_v2.projects.locations.keys.html @@ -79,10 +79,10 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

Creates a new API key. The key string of the API key is included in the response and can afterward only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.

delete(name, checkExistingUsage=None, etag=None, x__xgafv=None)

-

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.

get(name, x__xgafv=None)

Gets the metadata for an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

@@ -97,10 +97,10 @@

Instance Methods

Retrieves the next page of results.

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

-

Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

Patches the modifiable fields of an API key. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.

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

-

Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.

+

Undeletes an API key which was deleted within 30 days. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.

Method Details

close() @@ -109,7 +109,7 @@

Method Details

create(parent, body=None, keyId=None, x__xgafv=None) -
Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  
Creates a new API key. The key string of the API key is included in the response and can afterward only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.
 
 Args:
   parent: string, Required. The project in which the API key is created. The parent field must be in format of "projects//locations/global". (required)
@@ -124,7 +124,7 @@ 

Method Details

"deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters. "etag": "A String", # A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. - "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. + "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field is returned upon initial key creation (`CreateKey`) and can afterward be accessed only through the `GetKeyString` method. "name": "A String", # Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. "restrictions": { # Describes the restrictions on the key. # Key restrictions. "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key. @@ -196,7 +196,7 @@

Method Details

delete(name, checkExistingUsage=None, etag=None, x__xgafv=None) -
Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  
Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.
 
 Args:
   name: string, Required. The resource name of the API key to be deleted. (required)
@@ -257,7 +257,7 @@ 

Method Details

"deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters. "etag": "A String", # A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. - "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. + "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field is returned upon initial key creation (`CreateKey`) and can afterward be accessed only through the `GetKeyString` method. "name": "A String", # Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. "restrictions": { # Describes the restrictions on the key. # Key restrictions. "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key. @@ -344,7 +344,7 @@

Method Details

"deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters. "etag": "A String", # A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. - "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. + "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field is returned upon initial key creation (`CreateKey`) and can afterward be accessed only through the `GetKeyString` method. "name": "A String", # Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. "restrictions": { # Describes the restrictions on the key. # Key restrictions. "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key. @@ -404,7 +404,7 @@

Method Details

patch(name, body=None, checkExistingUsage=None, updateMask=None, x__xgafv=None) -
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  
Patches the modifiable fields of an API key. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.
 
 Args:
   name: string, Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. (required)
@@ -419,7 +419,7 @@ 

Method Details

"deleteTime": "A String", # Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. "displayName": "A String", # Human-readable display name of this key that you can modify. The maximum length is 63 characters. "etag": "A String", # A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. - "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. + "keyString": "A String", # Output only. An encrypted and signed value held by this key. This field is returned upon initial key creation (`CreateKey`) and can afterward be accessed only through the `GetKeyString` method. "name": "A String", # Identifier. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. "restrictions": { # Describes the restrictions on the key. # Key restrictions. "androidKeyRestrictions": { # The Android apps that are allowed to use the key. # The Android apps that are allowed to use the key. @@ -496,7 +496,7 @@

Method Details

undelete(name, body=None, x__xgafv=None) -
Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.
+  
Undeletes an API key which was deleted within 30 days. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.
 
 Args:
   name: string, Required. The resource name of the API key to be undeleted. (required)
diff --git a/docs/dyn/assuredworkloads_v1.html b/docs/dyn/assuredworkloads_v1.html
index fea59404d9..8edc157b35 100644
--- a/docs/dyn/assuredworkloads_v1.html
+++ b/docs/dyn/assuredworkloads_v1.html
@@ -74,21 +74,11 @@
 
 

Assured Workloads API

Instance Methods

-

- folders() -

-

Returns the folders Resource.

-

organizations()

Returns the organizations Resource.

-

- projects() -

-

Returns the projects Resource.

-

close()

Close httplib2 connections.

diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.html b/docs/dyn/assuredworkloads_v1.organizations.locations.html index 409ff9f45c..8b2f24f376 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.html @@ -74,21 +74,6 @@

Assured Workloads API . organizations . locations

Instance Methods

-

- dbFindingSummaries() -

-

Returns the dbFindingSummaries Resource.

- -

- dbFrameworkComplianceReports() -

-

Returns the dbFrameworkComplianceReports Resource.

- -

- dbFrameworkComplianceSummaries() -

-

Returns the dbFrameworkComplianceSummaries Resource.

-

operations()

diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html index 3930306e93..3dca2dca20 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.html @@ -129,7 +129,7 @@

Method Details

Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.
 
 Args:
-  target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
+  target: string, Required. The resource name of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
   assetTypes: string, Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). (repeated)
   pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.
   pageToken: string, Optional. The page token from the previous response. It needs to be passed in the second and following requests.
diff --git a/docs/dyn/assuredworkloads_v1beta1.html b/docs/dyn/assuredworkloads_v1beta1.html
index ed031cf364..a4e102b5c7 100644
--- a/docs/dyn/assuredworkloads_v1beta1.html
+++ b/docs/dyn/assuredworkloads_v1beta1.html
@@ -74,21 +74,11 @@
 
 

Assured Workloads API

Instance Methods

-

- folders() -

-

Returns the folders Resource.

-

organizations()

Returns the organizations Resource.

-

- projects() -

-

Returns the projects Resource.

-

close()

Close httplib2 connections.

diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html index db9089b2c1..3855859d45 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.html @@ -74,21 +74,6 @@

Assured Workloads API . organizations . locations

Instance Methods

-

- dbFindingSummaries() -

-

Returns the dbFindingSummaries Resource.

- -

- dbFrameworkComplianceReports() -

-

Returns the dbFrameworkComplianceReports Resource.

- -

- dbFrameworkComplianceSummaries() -

-

Returns the dbFrameworkComplianceSummaries Resource.

-

operations()

diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html index 8b3185a43c..8ed8968488 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.html @@ -126,7 +126,7 @@

Method Details

Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.
 
 Args:
-  target: string, Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
+  target: string, Required. The resource name of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2" (required)
   assetTypes: string, Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types). (repeated)
   pageSize: integer, Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.
   pageToken: string, Optional. The page token from the previous response. It needs to be passed in the second and following requests.
diff --git a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.html b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.html
index b6badcd5c1..1375cf5381 100644
--- a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.html
+++ b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.html
@@ -120,7 +120,7 @@ 

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. @@ -180,7 +180,7 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. @@ -259,7 +259,7 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. diff --git a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.matchingResources.html b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.matchingResources.html index 7ad47235fe..a503c7f85a 100644 --- a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.matchingResources.html +++ b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.bindings.matchingResources.html @@ -122,8 +122,8 @@

Method Details

"state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only. }, "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection. - "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` - "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). + "name": "A String", # Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` + "resource": "A String", # Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). }
@@ -163,8 +163,8 @@

Method Details

"state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only. }, "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection. - "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` - "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). + "name": "A String", # Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` + "resource": "A String", # Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). }, ], "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBindingMatchingResources` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. diff --git a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.html b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.html index 4d140fcb35..b0786e7c16 100644 --- a/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.html +++ b/docs/dyn/backupdr_v1.projects.locations.autoProtectionPolicies.html @@ -187,7 +187,7 @@

Method Details

Args: name: string, Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required) - etag: string, The current etag of the autoprotectionpolicy. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. + etag: string, Optional. The current etag of the autoprotectionpolicy. If an etag is provided and does not match the current etag of the connection, deletion will be blocked. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values @@ -324,7 +324,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], }
diff --git a/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.associations.html b/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.associations.html index 3cfc7877f2..fecd4ea6ef 100644 --- a/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.associations.html +++ b/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.associations.html @@ -116,7 +116,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. @@ -224,7 +224,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. @@ -273,7 +273,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. diff --git a/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.html b/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.html index bbadecfef1..7fa084d9d1 100644 --- a/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.html +++ b/docs/dyn/backupdr_v1.projects.locations.restoreVerificationPlans.html @@ -112,7 +112,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. +{ # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. @@ -215,7 +215,7 @@

Method Details

Returns: An object of the form: - { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. + { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. @@ -258,7 +258,7 @@

Method Details

{ # The response message for getting a list of `RestoreVerificationPlans`. "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListRestoreVerificationPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. "restoreVerificationPlans": [ # The list of `RestoreVerificationPlans` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return restore verification plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. - { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. + { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html index 16117ae10f..abd61d342f 100644 --- a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.html @@ -120,7 +120,7 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. @@ -180,7 +180,7 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. @@ -259,7 +259,7 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp when the binding was created. "description": "A String", # Optional. A description of the binding. The description must be at most 2048 characters. - "etag": "A String", # Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag. + "etag": "A String", # Output only. The etag for the binding. If this is provided on update, it must match the server's etag. "name": "A String", # Output only. Identifier. The resource name of the AutoProtectionPolicyBinding. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}` "scope": "A String", # Required. Immutable. Resource Id of target container on which policy will be applied. Format: projects/{project_id} "state": "A String", # Output only. The current state of the AutoProtectionPolicyBinding. diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html index 4123543fe1..ece711db70 100644 --- a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.bindings.matchingResources.html @@ -122,8 +122,8 @@

Method Details

"state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only. }, "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection. - "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` - "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). + "name": "A String", # Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` + "resource": "A String", # Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). }
@@ -163,8 +163,8 @@

Method Details

"state": "A String", # Output only. Protection state of the resource from the current binding's perspective. Output only. }, "lastEvaluationTime": "A String", # Output only. The timestamp when the resource was last evaluated for protection. - "name": "A String", # Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` - "resource": "A String", # Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). + "name": "A String", # Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}` + "resource": "A String", # Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`). }, ], "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListBindingMatchingResources` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. diff --git a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html index 80bc764437..2fdc89bee8 100644 --- a/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html +++ b/docs/dyn/backupdr_v1beta.projects.locations.autoProtectionPolicies.html @@ -187,7 +187,7 @@

Method Details

Args: name: string, Required. The name of the policy to delete. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy} (required) - etag: string, The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error. + etag: string, Optional. The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error. 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. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). x__xgafv: string, V1 error format. Allowed values @@ -324,7 +324,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], }
diff --git a/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.associations.html b/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.associations.html index 89b744a07a..c905022f5b 100644 --- a/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.associations.html +++ b/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.associations.html @@ -116,7 +116,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. @@ -224,7 +224,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. @@ -273,7 +273,7 @@

Method Details

"labels": { # Optional. User-defined labels. "a_key": "A String", }, - "name": "A String", # Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association} + "name": "A String", # Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}` "resourceType": "A String", # Required. Immutable. The type of the Google Cloud resource (e.g., `compute.googleapis.com/Instance`, `sqladmin.googleapis.com/Instance`). "restoreTemplate": "A String", # Required. Immutable. The canonical name of the RestoreTemplate to trigger. "state": "A String", # Output only. The `State` for the `RestoreVerificationPlanAssociation`. diff --git a/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.html b/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.html index 6f395c47dc..f9aae996d0 100644 --- a/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.html +++ b/docs/dyn/backupdr_v1beta.projects.locations.restoreVerificationPlans.html @@ -112,7 +112,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. +{ # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. @@ -215,7 +215,7 @@

Method Details

Returns: An object of the form: - { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. + { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. @@ -258,7 +258,7 @@

Method Details

{ # The response message for getting a list of `RestoreVerificationPlans`. "nextPageToken": "A String", # A token which may be sent as page_token in a subsequent `ListRestoreVerificationPlans` call to retrieve the next page of results. If this field is omitted or empty, then there are no more results to return. "restoreVerificationPlans": [ # The list of `RestoreVerificationPlans` in the project for the specified location. If the `{location}` value in the request is "-", the response contains a list of resources from all locations. In case any location is unreachable, the response will only return restore verification plans in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. - { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion. + { # A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion. "createTime": "A String", # Output only. When the `RestoreVerificationPlan` was created. "description": "A String", # Optional. The description of the `RestoreVerificationPlan` resource. The description allows for additional details about `RestoreVerificationPlan` and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters. "failureCleanupRule": { # Defines the specific cleanup action. # Optional. The cleanup rule to apply if the restore verification fails. diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index c72291cc03..a1dc190d47 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -136,6 +136,8 @@

Method Details

METADATA - View metadata information for the dataset, such as friendlyName, description, labels, etc. ACL - View ACL information for the dataset, which defines dataset access for one or more entities. FULL - View both dataset metadata and ACL information. + BASIC - View both dataset metadata and ACL information. + BASIC_REPLICA_METADATA_VIEW - Includes everything from the BASIC view plus replication information. However, it will not include sync_status or other fields requiring cross-region requests. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -205,6 +207,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -224,6 +227,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -314,6 +332,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -333,6 +352,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -422,6 +456,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -441,6 +476,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -595,6 +645,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -614,6 +665,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -709,6 +775,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -728,6 +795,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -831,6 +913,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -850,6 +933,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -941,6 +1039,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -960,6 +1059,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, @@ -1055,6 +1169,7 @@

Method Details

"connection": "A String", # Required. The connection id that is used to access the external_source. Format: projects/{project_id}/locations/{location_id}/connections/{connection_id} "externalSource": "A String", # Required. External source that backs this dataset. }, + "failoverReservationId": "A String", # Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview "friendlyName": "A String", # Optional. A descriptive name for the dataset. "id": "A String", # Output only. The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. "isCaseInsensitive": True or False, # Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references. @@ -1074,6 +1189,21 @@

Method Details

}, "location": "A String", # The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. "maxTimeTravelHours": "A String", # Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set. + "replicas": [ # Optional. The list of replicas in a cross region replicated or disaster recovery dataset. + { # The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset. + "backfillCompletionTime": "A String", # Output only. The time when the backfill was completed and replica is ready to use. + "creationTime": "A String", # Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time. + "failoverReservationUri": "A String", # Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. "projects/some-project/locations/US/reservations/some-reservation" The location portion of the format is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "id": "A String", # Required. The user-visible string identifier for this dataset replica. This is generally named after the region. + "location": "A String", # Required. The logical bigquery region where this replica is located. This is upper case if "US" or "EU", otherwise a lower case cloud region like "asia-northeast1". + "primaryAssignmentCompletionTime": "A String", # Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica. + "primaryAssignmentTime": "A String", # Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point. + "replicaOptions": { # Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region. # Optional. Contains modify options on the replica such as set a kms key on the replica. + "defaultKmsKeyName": "A String", # Optional. Default KMS encryption key name. + }, + "replicaState": "A String", # Output only. Gives an explicit indicator of the replica primary state. + }, + ], "resourceTags": { # Optional. The [tags](https://cloud.google.com/bigquery/docs/tags) attached to this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for example "123456789012/environment" where 123456789012 is the ID of the parent organization or project resource for this tag key. Tag value is expected to be the short name, for example "Production". See [Tag definitions](https://cloud.google.com/iam/docs/tags-access-control#definitions) for more details. "a_key": "A String", }, diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 536d6a2d3e..ac3562f0d8 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -1572,6 +1572,14 @@

Method Details

"typeSystem": "A String", # Required. Specifies the system which defines the foreign data type. }, }, + "searchIndexingStats": { # Statistics for a search indexing job. Populated as part of JobStatistics2. # Output only. Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the search index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the search index. + }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. { # Statistics for index pruning. @@ -1662,6 +1670,14 @@

Method Details

}, }, ], + "vectorSearchIndexingStats": { # Statistics for a vector search indexing job. Populated as part of JobStatistics2. # Output only. Vector Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the vector index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the vector index. + }, "vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics. "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). @@ -3245,6 +3261,14 @@

Method Details

"typeSystem": "A String", # Required. Specifies the system which defines the foreign data type. }, }, + "searchIndexingStats": { # Statistics for a search indexing job. Populated as part of JobStatistics2. # Output only. Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the search index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the search index. + }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. { # Statistics for index pruning. @@ -3335,6 +3359,14 @@

Method Details

}, }, ], + "vectorSearchIndexingStats": { # Statistics for a vector search indexing job. Populated as part of JobStatistics2. # Output only. Vector Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the vector index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the vector index. + }, "vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics. "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). @@ -5026,6 +5058,14 @@

Method Details

"typeSystem": "A String", # Required. Specifies the system which defines the foreign data type. }, }, + "searchIndexingStats": { # Statistics for a search indexing job. Populated as part of JobStatistics2. # Output only. Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the search index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the search index. + }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. { # Statistics for index pruning. @@ -5116,6 +5156,14 @@

Method Details

}, }, ], + "vectorSearchIndexingStats": { # Statistics for a vector search indexing job. Populated as part of JobStatistics2. # Output only. Vector Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the vector index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the vector index. + }, "vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics. "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). @@ -6670,6 +6718,14 @@

Method Details

"typeSystem": "A String", # Required. Specifies the system which defines the foreign data type. }, }, + "searchIndexingStats": { # Statistics for a search indexing job. Populated as part of JobStatistics2. # Output only. Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the search index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the search index. + }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. { # Statistics for index pruning. @@ -6760,6 +6816,14 @@

Method Details

}, }, ], + "vectorSearchIndexingStats": { # Statistics for a vector search indexing job. Populated as part of JobStatistics2. # Output only. Vector Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the vector index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the vector index. + }, "vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics. "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). @@ -8339,6 +8403,14 @@

Method Details

"typeSystem": "A String", # Required. Specifies the system which defines the foreign data type. }, }, + "searchIndexingStats": { # Statistics for a search indexing job. Populated as part of JobStatistics2. # Output only. Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the search index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the search index. + }, "searchStatistics": { # Statistics for a search query. Populated as part of JobStatistics2. # Output only. Search query specific statistics. "indexPruningStats": [ # Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table. { # Statistics for index pruning. @@ -8429,6 +8501,14 @@

Method Details

}, }, ], + "vectorSearchIndexingStats": { # Statistics for a vector search indexing job. Populated as part of JobStatistics2. # Output only. Vector Search indexing specific statistics. + "baseTable": { # Output only. The base table for which the vector index is being created or refreshed. + "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`. + }, + "indexName": "A String", # Output only. The name of the vector index. + }, "vectorSearchStatistics": { # Statistics for a vector search query. Populated as part of JobStatistics2. # Output only. Vector Search query specific statistics. "indexUnusedReasons": [ # When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the vector search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated. { # Reason about why no search index was used in the search query (or sub-query). @@ -8555,7 +8635,7 @@

Method Details

The object takes the form of: { # Describes the format of the jobs.query request. - "arrowSerializationOptions": { # Contains options specific to Arrow Serialization. This feature is not yet available. # Optional. Options specific to the Apache Arrow output format. + "arrowSerializationOptions": { # Contains options specific to Arrow Serialization. [Preview](https://cloud.google.com/products/#product-launch-stages) # Optional. Options specific to the Apache Arrow output format. "bufferCompression": "A String", # The compression codec to use for Arrow buffers in serialized record batches. "picosTimestampPrecision": "A String", # Optional. Set timestamp precision option. If not set, the default precision is microseconds. }, @@ -8623,7 +8703,7 @@

Method Details

}, }, ], - "queryResultsFormat": "A String", # Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available. + "queryResultsFormat": "A String", # Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results is provided in the `QueryResponse.results_schema` field. * The results of the first page are provided in the `QueryResponse.results` field. * The `QueryResponse.rows` is not populated. * The `QueryResponse.schema` for `QueryResponse.rows` is not populated since it is the schema of the `QueryResponse.rows`. [Preview](https://cloud.google.com/products/#product-launch-stages) "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. @@ -8646,10 +8726,10 @@

Method Details

An object of the form: { - "arrowRecordBatch": { # Arrow RecordBatch. This feature is not yet available. # Output only. Serialized row data in Arrow RecordBatch format. + "arrowRecordBatch": { # Arrow RecordBatch. [Preview](https://cloud.google.com/products/#product-launch-stages) # Output only. Serialized row data in Arrow RecordBatch format. "serializedRecordBatch": "A String", # IPC-serialized Arrow RecordBatch. }, - "arrowSchema": { # Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available. # Output only. Arrow schema + "arrowSchema": { # Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. [Preview](https://cloud.google.com/products/#product-launch-stages) # Output only. Arrow schema "serializedSchema": "A String", # IPC serialized Arrow schema. }, "cacheHit": True or False, # Whether the query result was fetched from the query cache. @@ -8682,7 +8762,7 @@

Method Details

"kind": "bigquery#queryResponse", # The resource type. "location": "A String", # Output only. The geographic location of the query. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "numDmlAffectedRows": "A String", # Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. - "pageRowCount": "A String", # Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available. + "pageRowCount": "A String", # Output only. The number of rows out of `total_rows` returned in this response. [Preview](https://cloud.google.com/products/#product-launch-stages) "pageToken": "A String", # A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the [`jobs.getQueryResults`](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/getQueryResults) method. For more information, see [Paging through table data](https://cloud.google.com/bigquery/docs/paging-results). "queryId": "A String", # Auto-generated ID for the query. "rows": [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index 78f8082289..d12c8dc8e7 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -183,6 +183,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -210,7 +217,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], @@ -384,6 +395,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -411,7 +429,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], @@ -526,6 +548,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -553,7 +582,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], @@ -683,6 +716,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -710,7 +750,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], @@ -960,6 +1004,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -987,7 +1038,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], @@ -1102,6 +1157,13 @@

Method Details

"reason": "A String", # A short error code that summarizes the error. }, "imageSizeBytes": "A String", # Output only. The size of the image in bytes. Populated only after the build succeeds. + "installedPackages": [ # Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds. + { # Information about a package installed in the routine execution environment. + "name": "A String", # Output only. The name of the installed package. + "sourceRepository": "A String", # Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple' + "version": "A String", # Output only. The version of the installed package. + }, + ], }, "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since the epoch. "dataGovernanceType": "A String", # Optional. If set to `DATA_MASKING`, the function is validated and made available as a masking function. For more information, see [Create custom masking routines](https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask). @@ -1129,7 +1191,11 @@

Method Details

"language": "A String", # Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds since the epoch. "pythonOptions": { # Options for a user-defined Python function. # Optional. Options for the Python UDF. [Preview](https://cloud.google.com/products/#product-launch-stages) + "buildConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: "projects/{project_id}/locations/{location_id}/connections/{connection_id}" "entryPoint": "A String", # Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked. + "extraPackageRepositories": [ # Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple'] + "A String", + ], "packages": [ # Optional. A list of Python package names along with versions to be installed. Example: ["pandas>=2.1", "google-cloud-translate==3.11"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages). "A String", ], diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 8c4cbe9b73..9568751716 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -155,6 +155,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -437,6 +438,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -700,6 +705,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -982,6 +988,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -1186,6 +1196,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -1468,6 +1479,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -1780,6 +1795,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -2062,6 +2078,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -2267,6 +2287,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -2549,6 +2570,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -2872,6 +2897,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -3154,6 +3180,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. @@ -3359,6 +3389,7 @@

Method Details

"biglakeConfiguration": { # Configuration for BigQuery tables for Apache Iceberg (formerly BigLake managed tables.) # Optional. Specifies the configuration of a BigQuery table for Apache Iceberg. "connectionId": "A String", # Optional. The connection specifying the credentials to be used to read and write to external storage, such as Cloud Storage. The connection_id can have the form `{project}.{location}.{connection_id}` or `projects/{project}/locations/{location}/connections/{connection_id}". "fileFormat": "A String", # Optional. The file format the table data is stored in. + "metadataExportMode": "A String", # Optional. The type of Metadata Export for BigLake Managed Tables. "storageUri": "A String", # Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/` "tableFormat": "A String", # Optional. The table format the metadata only snapshots are stored in. }, @@ -3641,6 +3672,10 @@

Method Details

}, ], }, + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views. + "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` + }, "rangePartitioning": { # If specified, configures range partitioning for this table. "field": "A String", # Required. The name of the column to partition the table on. It must be a top-level, INT64 column whose mode is NULLABLE or REQUIRED. "range": { # [Experimental] Defines the ranges for range partitioning. diff --git a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html index 9cf5457403..6d7305a438 100644 --- a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html +++ b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html @@ -124,10 +124,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -140,6 +142,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com @@ -259,10 +263,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -275,6 +281,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com @@ -418,10 +426,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -434,6 +444,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com @@ -619,10 +631,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -635,6 +649,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com @@ -772,10 +788,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -788,6 +806,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com @@ -907,10 +927,12 @@

Method Details

"accessRole": { # Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer's AWS IAM Role. # Authentication using Google owned service account to assume into customer's AWS IAM Role. "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. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`. }, "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. }, + "serviceDirectoryService": "A String", # Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence. }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. @@ -923,6 +945,8 @@

Method Details

"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. "objectId": "A String", # Output only. The object id of the Azure Active Directory Application. "redirectUri": "A String", # The URL user will be redirected to after granting consent during connection setup. + "serviceAccountId": "A String", # Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`. + "serviceDirectoryService": "A String", # Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. }, "cloudResource": { # Container for connection properties for delegation of access to GCP resources. # Cloud Resource properties. "serviceAccountId": "A String", # Output only. The account ID of the service created for the purpose of this connection. The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP. The account ID is in the form of: @gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com diff --git a/docs/dyn/ces_v1.projects.locations.apps.assistantSessions.html b/docs/dyn/ces_v1.projects.locations.apps.assistantSessions.html index 87f85573af..9a260d41b3 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.assistantSessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.assistantSessions.html @@ -170,13 +170,14 @@

Method Details

An object of the form: { # Response message for SessionService.StreamChatAiAssistant. - "artifactChunk": { # A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted. # Generated-document artifact event (live preview deltas + final GCS pointer). + "artifactChunk": { # A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the Cloud Storage URI once the file has been persisted. # Generated-document artifact event (live preview deltas + final Cloud Storage pointer). "artifactId": "A String", # Identifier of the artifact, stable across all chunks of one artifact within the stream. "contentDelta": "A String", # Incremental artifact content. Set on DELTA chunks. "displayName": "A String", # The file name shown to the user, e.g. "hotel_booking_tdd.md". Set on STARTED (and repeated on FINALIZED). - "gcsUri": "A String", # The GCS object the artifact was persisted to. Set on FINALIZED chunks. + "gcsUri": "A String", # The Cloud Storage object the artifact was persisted to. Set on FINALIZED chunks. "mimeType": "A String", # The IANA media type of the artifact content, e.g. "text/markdown". "state": "A String", # Lifecycle position of this chunk. + "targetApp": "A String", # Output only. The app this artifact was produced for, when it was produced for one. Format: `projects/{project}/locations/{location}/apps/{app}` }, "confirmationRequest": { # A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later StreamChatAiAssistantRequest.confirmation_response. # A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's `confirmation_response`. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request. "agentName": "A String", # Display label of the agent that raised the confirmation (e.g. `"Contract Architect"`), for the card header. @@ -197,6 +198,14 @@

Method Details

"question": "A String", # The question header text. }, ], + "targets": [ # Everything the confirmed action will change, so the console can render "Update 2 apps" and one badge per app. Empty for legacy single-target cards. + { # One resource the confirmed action will change. + "action": "A String", # The action, e.g. `CREATE`, `UPDATE`, `DELETE`, `COPY`, `LINK`. + "displayName": "A String", # Display name of the resource or app, for the card. + "resource": "A String", # The resource that will change, as a full resource name. + "targetApp": "A String", # The app the resource belongs to, or empty for a location-scoped action such as creating an app. Format: `projects/{project}/locations/{location}/apps/{app}` + }, + ], "tool": "A String", # Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions. }, "eventId": "A String", # Unique identifier for the event. @@ -250,6 +259,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -264,6 +274,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -273,6 +284,9 @@

Method Details

"turnCompleted": { # Terminal event of a turn (see StreamChatAiAssistantResponse.turn_completed). # The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure. "finalSequenceNumber": "A String", # Sequence number of the last event the turn produced. A client whose cursor is lower missed content and should reload the session to see it. "reason": "A String", # Why the turn ended. + "touchedApps": [ # Apps this turn targeted or changed, so the console can refresh exactly those apps' stores. Project-scoped sessions only. Format: `projects/{project}/locations/{location}/apps/{app}` + "A String", + ], "turnId": "A String", # Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id. }, "turnInProgress": True or False, # Optional. Indicates whether the turn is still actively running in the background. diff --git a/docs/dyn/ces_v1.projects.locations.apps.conversations.html b/docs/dyn/ces_v1.projects.locations.apps.conversations.html index b2462c6e03..d7022af156 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1.projects.locations.apps.conversations.html @@ -230,6 +230,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -244,6 +245,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -298,6 +300,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -312,6 +315,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -421,6 +425,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -435,6 +440,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -489,6 +495,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -503,6 +510,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1.projects.locations.apps.deployments.html b/docs/dyn/ces_v1.projects.locations.apps.deployments.html index 1eafc23bba..3e874b9fdd 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1.projects.locations.apps.deployments.html @@ -166,11 +166,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -254,11 +254,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -367,11 +367,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -637,11 +637,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -743,11 +743,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -831,11 +831,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, diff --git a/docs/dyn/ces_v1.projects.locations.apps.examples.html b/docs/dyn/ces_v1.projects.locations.apps.examples.html index 77425de981..b97f5be518 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.examples.html +++ b/docs/dyn/ces_v1.projects.locations.apps.examples.html @@ -149,6 +149,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -163,6 +164,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -231,6 +233,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -245,6 +248,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -338,6 +342,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -352,6 +357,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -432,6 +438,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -446,6 +453,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -532,6 +540,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -546,6 +555,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -614,6 +624,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -628,6 +639,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html index 088764489e..7f552ff1bb 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.html +++ b/docs/dyn/ces_v1.projects.locations.apps.html @@ -648,7 +648,7 @@

Method Details

{ # Request message for AgentService.ExportApp. "appVersion": "A String", # Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`. "exportFormat": "A String", # Required. The format to export the app in. - "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object. + "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified Cloud Storage object. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html index 142958b77b..d066d65b63 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -182,6 +183,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -254,6 +256,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -334,6 +337,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -348,6 +352,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -413,6 +418,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -475,6 +481,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -489,6 +496,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -561,6 +569,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -641,6 +650,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -655,6 +665,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -720,6 +731,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html index 82d7af2d53..23c6bfac9e 100644 --- a/docs/dyn/ces_v1.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html @@ -643,6 +643,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -657,6 +658,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2080,6 +2082,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2094,6 +2097,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3542,6 +3546,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3556,6 +3561,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5162,6 +5168,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5176,6 +5183,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6617,6 +6625,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6631,6 +6640,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8054,6 +8064,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8068,6 +8079,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.assistantSessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.assistantSessions.html index 86d09f9db4..cd4af02658 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.assistantSessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.assistantSessions.html @@ -154,7 +154,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. @@ -213,7 +213,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. @@ -235,6 +235,9 @@

Method Details

"userIntent": "A String", # Inferred user goal or topic for the session (e.g. "Building E-Commerce Support Agent"). }, "state": "A String", # Output only. The status of the assistant session. + "touchedApps": [ # Output only. Apps this session has targeted or changed (project-scoped sessions only), for history tags. Format: `projects/{project}/locations/{location}/apps/{app}` + "A String", + ], "updateTime": "A String", # Output only. The time the assistant session was last updated. "userResponseSuggestions": { # Suggested user responses from the assistant agent. # Output only. Suggested user responses from the assistant agent. "suggestions": [ # Required. The assistant suggested user responses. These are suggestions for the user on how to interact with the assistant. @@ -309,7 +312,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. @@ -331,6 +334,9 @@

Method Details

"userIntent": "A String", # Inferred user goal or topic for the session (e.g. "Building E-Commerce Support Agent"). }, "state": "A String", # Output only. The status of the assistant session. + "touchedApps": [ # Output only. Apps this session has targeted or changed (project-scoped sessions only), for history tags. Format: `projects/{project}/locations/{location}/apps/{app}` + "A String", + ], "updateTime": "A String", # Output only. The time the assistant session was last updated. "userResponseSuggestions": { # Suggested user responses from the assistant agent. # Output only. Suggested user responses from the assistant agent. "suggestions": [ # Required. The assistant suggested user responses. These are suggestions for the user on how to interact with the assistant. @@ -392,7 +398,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. @@ -414,6 +420,9 @@

Method Details

"userIntent": "A String", # Inferred user goal or topic for the session (e.g. "Building E-Commerce Support Agent"). }, "state": "A String", # Output only. The status of the assistant session. + "touchedApps": [ # Output only. Apps this session has targeted or changed (project-scoped sessions only), for history tags. Format: `projects/{project}/locations/{location}/apps/{app}` + "A String", + ], "updateTime": "A String", # Output only. The time the assistant session was last updated. "userResponseSuggestions": { # Suggested user responses from the assistant agent. # Output only. Suggested user responses from the assistant agent. "suggestions": [ # Required. The assistant suggested user responses. These are suggestions for the user on how to interact with the assistant. @@ -495,13 +504,14 @@

Method Details

An object of the form: { # Response message for SessionService.StreamChatAiAssistant. - "artifactChunk": { # A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted. # Generated-document artifact event (live preview deltas + final GCS pointer). + "artifactChunk": { # A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the Cloud Storage URI once the file has been persisted. # Generated-document artifact event (live preview deltas + final Cloud Storage pointer). "artifactId": "A String", # Identifier of the artifact, stable across all chunks of one artifact within the stream. "contentDelta": "A String", # Incremental artifact content. Set on DELTA chunks. "displayName": "A String", # The file name shown to the user, e.g. "hotel_booking_tdd.md". Set on STARTED (and repeated on FINALIZED). - "gcsUri": "A String", # The GCS object the artifact was persisted to. Set on FINALIZED chunks. + "gcsUri": "A String", # The Cloud Storage object the artifact was persisted to. Set on FINALIZED chunks. "mimeType": "A String", # The IANA media type of the artifact content, e.g. "text/markdown". "state": "A String", # Lifecycle position of this chunk. + "targetApp": "A String", # Output only. The app this artifact was produced for, when it was produced for one. Format: `projects/{project}/locations/{location}/apps/{app}` }, "confirmationRequest": { # A blocking question or confirmation the assistant needs answered before an agent action can proceed. The requesting agent is paused and resumes only when the answer arrives on a later StreamChatAiAssistantRequest.confirmation_response. # A blocking confirmation the agent paused on. The agent resumes when the answer arrives on a later request's `confirmation_response`. Only sent to clients that declared the CONFIRMATION_CARDS capability on the request. "agentName": "A String", # Display label of the agent that raised the confirmation (e.g. `"Contract Architect"`), for the card header. @@ -522,6 +532,14 @@

Method Details

"question": "A String", # The question header text. }, ], + "targets": [ # Everything the confirmed action will change, so the console can render "Update 2 apps" and one badge per app. Empty for legacy single-target cards. + { # One resource the confirmed action will change. + "action": "A String", # The action, e.g. `CREATE`, `UPDATE`, `DELETE`, `COPY`, `LINK`. + "displayName": "A String", # Display name of the resource or app, for the card. + "resource": "A String", # The resource that will change, as a full resource name. + "targetApp": "A String", # The app the resource belongs to, or empty for a location-scoped action such as creating an app. Format: `projects/{project}/locations/{location}/apps/{app}` + }, + ], "tool": "A String", # Name of the tool call the agent paused on (e.g. "update_app"), for the card header. Unset for pure questions. }, "eventId": "A String", # Unique identifier for the event. @@ -575,6 +593,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -589,6 +608,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -598,6 +618,9 @@

Method Details

"turnCompleted": { # Terminal event of a turn (see StreamChatAiAssistantResponse.turn_completed). # The turn has ended. Sent as the last event of every turn, on the original stream and on every attached or resumed stream, so clients can end the turn on an explicit signal instead of inferring it from stream closure. "finalSequenceNumber": "A String", # Sequence number of the last event the turn produced. A client whose cursor is lower missed content and should reload the session to see it. "reason": "A String", # Why the turn ended. + "touchedApps": [ # Apps this turn targeted or changed, so the console can refresh exactly those apps' stores. Project-scoped sessions only. Format: `projects/{project}/locations/{location}/apps/{app}` + "A String", + ], "turnId": "A String", # Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id. }, "turnInProgress": True or False, # Optional. Indicates whether the turn is still actively running in the background. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html index 4dea022b3c..000d58b02f 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.conversations.html @@ -276,6 +276,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -290,6 +291,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -344,6 +346,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -358,6 +361,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -467,6 +471,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -481,6 +486,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -535,6 +541,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -549,6 +556,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html index 230f2ee6b9..889dd44dfc 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.deployments.html @@ -166,11 +166,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -254,11 +254,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -367,11 +367,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -637,11 +637,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -743,11 +743,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, @@ -831,11 +831,11 @@

Method Details

"experimentConfig": { # Experiment for the deployment. # Optional. Experiment configuration for the deployment. "versionRelease": { # Version release for the experiment. # Optional. Version release for the experiment. "state": "A String", # Optional. State of the version release. - "trafficAllocations": [ # Optional. Traffic allocations for the version release. + "trafficAllocations": [ # Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic. { # Traffic allocation for the version release. "appVersion": "A String", # Optional. App version of the traffic allocation. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}` "id": "A String", # Optional. Id of the traffic allocation. Free format string, up to 128 characters. - "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100. + "trafficPercentage": 42, # Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`. }, ], }, diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html index 40a799b3dc..ad29d43947 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html @@ -299,6 +299,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -313,6 +314,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -350,6 +352,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -367,6 +370,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -381,6 +385,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -421,6 +426,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -553,6 +559,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -567,6 +574,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -604,6 +612,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -621,6 +630,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -635,6 +645,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -676,6 +687,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -690,6 +702,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -720,6 +733,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -734,6 +748,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -872,6 +887,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -886,6 +902,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -910,6 +927,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -924,6 +942,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -963,6 +982,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -977,6 +997,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1001,6 +1022,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1015,6 +1037,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1032,6 +1055,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -1193,6 +1235,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1207,6 +1250,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1244,6 +1288,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1261,6 +1306,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1275,6 +1321,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1316,6 +1363,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1330,6 +1378,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1360,6 +1409,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1374,6 +1424,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1512,6 +1563,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1526,6 +1578,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1550,6 +1603,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1564,6 +1618,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1603,6 +1658,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1617,6 +1673,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1641,6 +1698,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1655,6 +1713,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1672,6 +1731,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -1732,6 +1810,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -1769,6 +1862,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1783,6 +1877,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1807,6 +1902,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1821,6 +1917,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2036,6 +2133,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2050,6 +2148,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2087,6 +2186,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2104,6 +2204,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2118,6 +2219,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2158,6 +2260,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2290,6 +2393,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2304,6 +2408,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2341,6 +2446,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2358,6 +2464,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2372,6 +2479,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2413,6 +2521,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2427,6 +2536,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2457,6 +2567,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2471,6 +2582,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2609,6 +2721,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2623,6 +2736,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2647,6 +2761,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2661,6 +2776,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2700,6 +2816,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2714,6 +2831,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2738,6 +2856,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2752,6 +2871,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2769,6 +2889,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -2930,6 +3069,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2944,6 +3084,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2981,6 +3122,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2998,6 +3140,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3012,6 +3155,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3053,6 +3197,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3067,6 +3212,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3097,6 +3243,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3111,6 +3258,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3249,6 +3397,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3263,6 +3412,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3287,6 +3437,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3301,6 +3452,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3340,6 +3492,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3354,6 +3507,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3378,6 +3532,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3392,6 +3547,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3409,6 +3565,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -3469,6 +3644,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -3506,6 +3696,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3520,6 +3711,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3544,6 +3736,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3558,6 +3751,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3849,6 +4043,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3863,6 +4058,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3900,6 +4096,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3917,6 +4114,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3931,6 +4129,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3971,6 +4170,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4103,6 +4303,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4117,6 +4318,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4154,6 +4356,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4171,6 +4374,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4185,6 +4389,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4226,6 +4431,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4240,6 +4446,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4270,6 +4477,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4284,6 +4492,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4422,6 +4631,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4436,6 +4646,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4460,6 +4671,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4474,6 +4686,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4513,6 +4726,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4527,6 +4741,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4551,6 +4766,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4565,6 +4781,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4582,6 +4799,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -4743,6 +4979,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4757,6 +4994,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4794,6 +5032,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4811,6 +5050,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4825,6 +5065,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4866,6 +5107,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4880,6 +5122,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4910,6 +5153,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -4924,6 +5168,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5062,6 +5307,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5076,6 +5322,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5100,6 +5347,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5114,6 +5362,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5153,6 +5402,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5167,6 +5417,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5191,6 +5442,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5205,6 +5457,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5222,6 +5475,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -5282,6 +5554,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -5319,6 +5606,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5333,6 +5621,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5357,6 +5646,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5371,6 +5661,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5601,6 +5892,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5615,6 +5907,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5652,6 +5945,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5669,6 +5963,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5683,6 +5978,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5723,6 +6019,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5855,6 +6152,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5869,6 +6167,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5906,6 +6205,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5923,6 +6223,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5937,6 +6238,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5978,6 +6280,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5992,6 +6295,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6022,6 +6326,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6036,6 +6341,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6174,6 +6480,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6188,6 +6495,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6212,6 +6520,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6226,6 +6535,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6265,6 +6575,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6279,6 +6590,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6303,6 +6615,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6317,6 +6630,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6334,6 +6648,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -6495,6 +6828,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6509,6 +6843,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6546,6 +6881,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6563,6 +6899,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6577,6 +6914,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6618,6 +6956,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6632,6 +6971,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6662,6 +7002,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6676,6 +7017,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6814,6 +7156,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6828,6 +7171,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6852,6 +7196,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6866,6 +7211,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6905,6 +7251,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6919,6 +7266,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6943,6 +7291,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6957,6 +7306,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6974,6 +7324,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -7034,6 +7403,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -7071,6 +7455,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7085,6 +7470,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7109,6 +7495,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7123,6 +7510,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7356,6 +7744,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7370,6 +7759,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7407,6 +7797,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7424,6 +7815,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7438,6 +7830,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7478,6 +7871,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7610,6 +8004,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7624,6 +8019,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7661,6 +8057,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7678,6 +8075,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7692,6 +8090,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7733,6 +8132,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7747,6 +8147,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7777,6 +8178,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7791,6 +8193,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7929,6 +8332,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7943,6 +8347,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7967,6 +8372,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -7981,6 +8387,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8020,6 +8427,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8034,6 +8442,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8058,6 +8467,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8072,6 +8482,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8089,6 +8500,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -8250,6 +8680,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8264,6 +8695,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8301,6 +8733,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8318,6 +8751,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8332,6 +8766,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8373,6 +8808,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8387,6 +8823,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8417,6 +8854,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8431,6 +8869,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8569,6 +9008,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8583,6 +9023,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8607,6 +9048,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8621,6 +9063,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8660,6 +9103,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8674,6 +9118,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8698,6 +9143,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8712,6 +9158,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8729,6 +9176,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -8789,6 +9255,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -8826,6 +9307,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8840,6 +9322,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8864,6 +9347,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8878,6 +9362,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9093,6 +9578,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9107,6 +9593,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9144,6 +9631,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9161,6 +9649,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9175,6 +9664,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9215,6 +9705,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9347,6 +9838,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9361,6 +9853,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9398,6 +9891,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9415,6 +9909,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9429,6 +9924,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9470,6 +9966,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9484,6 +9981,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9514,6 +10012,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9528,6 +10027,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9666,6 +10166,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9680,6 +10181,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9704,6 +10206,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9718,6 +10221,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9757,6 +10261,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9771,6 +10276,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9795,6 +10301,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9809,6 +10316,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -9826,6 +10334,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -9987,6 +10514,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10001,6 +10529,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10038,6 +10567,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10055,6 +10585,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10069,6 +10600,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10110,6 +10642,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10124,6 +10657,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10154,6 +10688,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10168,6 +10703,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10306,6 +10842,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10320,6 +10857,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10344,6 +10882,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10358,6 +10897,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10397,6 +10937,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10411,6 +10952,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10435,6 +10977,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10449,6 +10992,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10466,6 +11010,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -10526,6 +11089,21 @@

Method Details

"A String", ], "maxTurns": 42, # Optional. The maximum number of turns to simulate. The maximum allowed value is 100. The default value is 100. + "milestones": [ # Optional. The milestones for this scenario. + { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + ], "rubrics": [ # Required. The rubrics to score the scenario against. "A String", ], @@ -10563,6 +11141,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10577,6 +11156,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10601,6 +11181,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -10615,6 +11196,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html index a3cbc744ef..cf0e785cdc 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html @@ -289,6 +289,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -303,6 +304,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -340,6 +342,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -357,6 +360,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -371,6 +375,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -412,6 +417,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -426,6 +432,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -456,6 +463,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -470,6 +478,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -608,6 +617,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -622,6 +632,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -646,6 +657,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -660,6 +672,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -699,6 +712,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -713,6 +727,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -737,6 +752,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -751,6 +767,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -768,6 +785,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. @@ -950,6 +986,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -964,6 +1001,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1001,6 +1039,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1018,6 +1057,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1032,6 +1072,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1073,6 +1114,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1087,6 +1129,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1117,6 +1160,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1131,6 +1175,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1269,6 +1314,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1283,6 +1329,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1307,6 +1354,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1321,6 +1369,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1360,6 +1409,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1374,6 +1424,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1398,6 +1449,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1412,6 +1464,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -1429,6 +1482,25 @@

Method Details

"score": 42, # Output only. The hallucination score. Can be -1, 0, 1. }, ], + "milestoneResults": [ # Output only. The results of each milestone in the scenario. + { # Represents the result of a milestone execution. + "justification": "A String", # Output only. The justification for the current status. + "milestone": { # Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved. # Output only. The milestone being tracked. + "event": { # Event input. # Optional. An event input to send instead of dynamic generation. + "event": "A String", # Required. The name of the event. + "variables": { # Optional. Additional variables associated with the event. + "a_key": "", # Properties of the object. + }, + }, + "goal": "A String", # Required. The goal of the milestone. + "maxTurnCount": 42, # Optional. The maximum number of turns for this milestone. + "protocol": "A String", # Optional. The guidelines the agent should follow during the conversation. + "staticUtterance": "A String", # Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input. + "successCriteria": "A String", # Optional. The success criteria of the milestone. + }, + "status": "A String", # Output only. The current status of the milestone. + }, + ], "rubricOutcomes": [ # Output only. The outcome of the rubric. { # The outcome of the evaluation against the rubric. "rubric": "A String", # Output only. The rubric that was used to evaluate the conversation. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html index b53c1d8b9a..219b0a7fee 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.examples.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.examples.html @@ -149,6 +149,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -163,6 +164,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -231,6 +233,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -245,6 +248,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -338,6 +342,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -352,6 +357,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -432,6 +438,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -446,6 +453,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -532,6 +540,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -546,6 +555,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -614,6 +624,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -628,6 +639,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html index cbd6ff03f4..055d5c7340 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.html @@ -776,7 +776,7 @@

Method Details

{ # Request message for AgentService.ExportApp. "appVersion": "A String", # Optional. The resource name of the app version to export. Format: `projects/{project}/locations/{location}/apps/{app}/versions/{version}`. "exportFormat": "A String", # Required. The format to export the app in. - "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object. + "gcsUri": "A String", # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified Cloud Storage object. } x__xgafv: string, V1 error format. @@ -3703,7 +3703,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. @@ -3742,7 +3742,7 @@

Method Details

}, "text": "A String", # Optional. Text data. "thought": "A String", # Optional. Thought generated by the model. - "typedPayload": { # Payload with a type. # Optional. Typed payload which contains structured responses. + "typedPayload": { # Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it. # Optional. Typed payload which contains structured responses. "displayName": "A String", # Required. The display name of the payload. "metadata": { # Optional. The metadata of the payload. "a_key": "", # Properties of the object. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html index 836b1719bc..3661fd5881 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -182,6 +183,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -254,6 +256,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -334,6 +337,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -348,6 +352,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -413,6 +418,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -475,6 +481,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -489,6 +496,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -561,6 +569,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -641,6 +650,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -655,6 +665,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -720,6 +731,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html index 16eb821483..b5e0af7f3c 100644 --- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html +++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html @@ -687,6 +687,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -701,6 +702,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2168,6 +2170,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -2182,6 +2185,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3674,6 +3678,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -3688,6 +3693,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5338,6 +5344,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -5352,6 +5359,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6837,6 +6845,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -6851,6 +6860,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8318,6 +8328,7 @@

Method Details

"displayName": "A String", # Output only. Display name of the tool. "id": "A String", # Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse. "parentToolCallId": "A String", # Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. + "targetApp": "A String", # Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool to execute. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. @@ -8332,6 +8343,7 @@

Method Details

"response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result. "a_key": "", # Properties of the object. }, + "targetApp": "A String", # Output only. The app the executed tool targeted; mirrors ToolCall.target_app. "tool": "A String", # Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}` "toolsetTool": { # A tool that is created from a toolset. # Optional. The toolset tool that got executed. "toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 6b3394c451..239d905611 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -1183,7 +1183,7 @@

Method Details

"type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. } - updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership` + updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership` useAdminAccess: boolean, Optional. When `true`, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the [manage chat and spaces conversations privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.spaces` [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes). Some `FieldMask` values are not supported using admin access. For details, see the description of `update_mask`. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/chat_v1.users.spaces.threads.html b/docs/dyn/chat_v1.users.spaces.threads.html index 7d4db878a1..1b322a5aa2 100644 --- a/docs/dyn/chat_v1.users.spaces.threads.html +++ b/docs/dyn/chat_v1.users.spaces.threads.html @@ -80,6 +80,9 @@

Instance Methods

getThreadReadState(name, x__xgafv=None)

Returns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate.readonly` - `https://www.googleapis.com/auth/chat.users.readstate`

+

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

+

Updates a user's read state within a thread, used to identify read and unread messages. For an example, see [Update a user's thread read state](https://developers.google.com/workspace/chat/update-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`

Method Details

close() @@ -106,4 +109,33 @@

Method Details

}
+
+ updateThreadReadState(name, body=None, updateMask=None, x__xgafv=None) +
Updates a user's read state within a thread, used to identify read and unread messages. For an example, see [Update a user's thread read state](https://developers.google.com/workspace/chat/update-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`
+
+Args:
+  name: string, Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A user's read state within a thread, used to identify read and unread messages.
+  "lastReadTime": "A String", # The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.
+  "name": "A String", # Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`
+}
+
+  updateMask: string, Required. The field paths to update. Currently supported field paths: - `last_read_time` When `last_read_time` is before the latest message create time, the thread appears as unread in the UI. To mark the thread as read, set `last_read_time` to a timestamp equal to or later than the latest message create time. Future timestamps are coerced to the current request time. Setting a negative timestamp (before `1970-01-01T00:00:00Z`) returns an `INVALID_ARGUMENT` error.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user's read state within a thread, used to identify read and unread messages.
+  "lastReadTime": "A String", # The time when the user's thread read state was updated. Usually this corresponds with the timestamp of the last read message in a thread.
+  "name": "A String", # Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/chromemanagement_v1.customers.html b/docs/dyn/chromemanagement_v1.customers.html index 3668426a4d..7444032b02 100644 --- a/docs/dyn/chromemanagement_v1.customers.html +++ b/docs/dyn/chromemanagement_v1.customers.html @@ -127,10 +127,57 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getSubscriptionInfo(name, x__xgafv=None)

+

Gets the aggregated subscription and license information for a given customer as a singleton resource. Note: Because the data is snapshotted for ChromeOS devices, the exact numbers can be delayed by up to 10 seconds.

Method Details

close()
Close httplib2 connections.
+
+ getSubscriptionInfo(name, x__xgafv=None) +
Gets the aggregated subscription and license information for a given customer as a singleton resource. Note: Because the data is snapshotted for ChromeOS devices, the exact numbers can be delayed by up to 10 seconds.
+
+Args:
+  name: string, Required. The resource name of the customer subscription info to retrieve. Format: customers/{customer}/subscriptionInfo (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Singleton resource representing the subscription and license information for a given customer.
+  "chromeEnterpriseUpgradeAnnual": { # Information for annually recurring subscriptions/licenses. # Output only. Details for Chrome Enterprise Upgrade Annual SKU.
+    "counts": { # Resource counts for a specific license type. # Output only. License counts for this subscription.
+      "assignedCount": "A String", # Output only. Total number of licenses currently assigned to users or devices.
+      "totalPurchasedCount": "A String", # Output only. Total number of licenses purchased.
+      "unassignedCount": "A String", # Output only. Total number of licenses available for assignment.
+    },
+    "subscriptionEndTime": "A String", # Output only. The date when the current subscription period ends.
+  },
+  "chromePerpetualUpgrade": { # Information for perpetual licenses. # Output only. Details for Chrome Ent/Edu Upgrade Perpetual SKU.
+    "conditionallyAvailableCount": "A String", # Output only. Number of standalone perpetual upgrades that were previously enrolled and later unenrolled for RMA, warranty, or repair reasons, and are only available to be reused on a same model device. Conditionally available licenses are a subset of the Assigned total.
+    "counts": { # Resource counts for a specific license type. # Output only. License counts for the perpetual SKU.
+      "assignedCount": "A String", # Output only. Total number of licenses currently assigned to users or devices.
+      "totalPurchasedCount": "A String", # Output only. Total number of licenses purchased.
+      "unassignedCount": "A String", # Output only. Total number of licenses available for assignment.
+    },
+    "retiredCount": "A String", # Output only. Number of perpetual upgrades that were purchased but are no longer available for enrollment. These are perpetual upgrades that were enrolled to a device that has since been retired, and the upgrade cannot be transferred or re-used on a different device. Retired licenses are a subset of the Assigned total.
+  },
+  "kioskSignageUpgradeAnnual": { # Information for annually recurring subscriptions/licenses. # Output only. Details for Kiosk & Signage Upgrade Annual SKU.
+    "counts": { # Resource counts for a specific license type. # Output only. License counts for this subscription.
+      "assignedCount": "A String", # Output only. Total number of licenses currently assigned to users or devices.
+      "totalPurchasedCount": "A String", # Output only. Total number of licenses purchased.
+      "unassignedCount": "A String", # Output only. Total number of licenses available for assignment.
+    },
+    "subscriptionEndTime": "A String", # Output only. The date when the current subscription period ends.
+  },
+  "name": "A String", # Identifier. The resource name of the customer subscription info. Format: customers/{customer}/subscriptionInfo
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index 9c1bb63609..6accb4d2ee 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -322,7 +322,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -819,7 +819,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1347,7 +1347,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1850,7 +1850,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index f7689f1fc3..c2144f3faf 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -321,7 +321,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -818,7 +818,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1346,7 +1346,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1849,7 +1849,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 570d3a6d0c..7174a92163 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -310,7 +310,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -951,7 +951,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1620,7 +1620,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -2273,7 +2273,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -2931,7 +2931,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -3574,7 +3574,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html index 1eee1765cb..aaf5b998be 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.workerPools.html @@ -125,7 +125,7 @@

Method Details

"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment) "peeredNetworkIpRange": "A String", # Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. }, - "privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool. + "privateServiceConnect": { # Deprecated: Private Service Connect is no longer supported. Defines the Private Service Connect network configuration for the pool. # Immutable. Deprecated: Private Service Connect is no longer supported. Private Service Connect(PSC) Network configuration for the pool. "networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments) "publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect. "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface. @@ -134,7 +134,7 @@

Method Details

"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "enableNestedVirtualization": True or False, # Optional. Enable nested virtualization on the worker, if supported by the machine type. By default, nested virtualization is disabled. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. + "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning worker VMs. The pool's requirements will be matched to a [pre-sized machine type](/compute/docs/general-purpose-machines) which is available in the pool's region. If left blank, Cloud Build will use a sensible default. "A String", ], "workerRelease": "A String", # Optional. Option to specify which release or release channel (rapid|regular|stable) to use to run this build. @@ -243,7 +243,7 @@

Method Details

"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment) "peeredNetworkIpRange": "A String", # Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. }, - "privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool. + "privateServiceConnect": { # Deprecated: Private Service Connect is no longer supported. Defines the Private Service Connect network configuration for the pool. # Immutable. Deprecated: Private Service Connect is no longer supported. Private Service Connect(PSC) Network configuration for the pool. "networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments) "publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect. "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface. @@ -252,7 +252,7 @@

Method Details

"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "enableNestedVirtualization": True or False, # Optional. Enable nested virtualization on the worker, if supported by the machine type. By default, nested virtualization is disabled. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. + "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning worker VMs. The pool's requirements will be matched to a [pre-sized machine type](/compute/docs/general-purpose-machines) which is available in the pool's region. If left blank, Cloud Build will use a sensible default. "A String", ], "workerRelease": "A String", # Optional. Option to specify which release or release channel (rapid|regular|stable) to use to run this build. @@ -298,7 +298,7 @@

Method Details

"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment) "peeredNetworkIpRange": "A String", # Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. }, - "privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool. + "privateServiceConnect": { # Deprecated: Private Service Connect is no longer supported. Defines the Private Service Connect network configuration for the pool. # Immutable. Deprecated: Private Service Connect is no longer supported. Private Service Connect(PSC) Network configuration for the pool. "networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments) "publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect. "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface. @@ -307,7 +307,7 @@

Method Details

"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "enableNestedVirtualization": True or False, # Optional. Enable nested virtualization on the worker, if supported by the machine type. By default, nested virtualization is disabled. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. + "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning worker VMs. The pool's requirements will be matched to a [pre-sized machine type](/compute/docs/general-purpose-machines) which is available in the pool's region. If left blank, Cloud Build will use a sensible default. "A String", ], "workerRelease": "A String", # Optional. Option to specify which release or release channel (rapid|regular|stable) to use to run this build. @@ -359,7 +359,7 @@

Method Details

"peeredNetwork": "A String", # Required. Immutable. The network definition that the workers are peered to. If this section is left empty, the workers will be peered to `WorkerPool.project_id` on the service producer network. Must be in the format `projects/{project}/global/networks/{network}`, where `{project}` is a project number, such as `12345`, and `{network}` is the name of a VPC network in the project. See [Understanding network configuration options](https://cloud.google.com/build/docs/private-pools/set-up-private-pool-environment) "peeredNetworkIpRange": "A String", # Immutable. Subnet IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a prefix size of 29 bits. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. }, - "privateServiceConnect": { # Defines the Private Service Connect network configuration for the pool. # Immutable. Private Service Connect(PSC) Network configuration for the pool. + "privateServiceConnect": { # Deprecated: Private Service Connect is no longer supported. Defines the Private Service Connect network configuration for the pool. # Immutable. Deprecated: Private Service Connect is no longer supported. Private Service Connect(PSC) Network configuration for the pool. "networkAttachment": "A String", # Required. Immutable. The network attachment that the worker network interface is peered to. Must be in the format `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. The region of network attachment must be the same as the worker pool. See [Network Attachments](https://cloud.google.com/vpc/docs/about-network-attachments) "publicIpAddressDisabled": True or False, # Required. Immutable. Disable public IP on the primary network interface. If true, workers are created without any public address, which prevents network egress to public IPs unless a network proxy is configured. If false, workers are created with a public address which allows for public internet egress. The public address only applies to traffic through the primary network interface. If `route_all_traffic` is set to true, all traffic will go through the non-primary network interface, this boolean has no effect. "routeAllTraffic": True or False, # Immutable. Route all traffic through PSC interface. Enable this if you want full control of traffic in the private pool. Configure Cloud NAT for the subnet of network attachment if you need to access public Internet. If false, Only route RFC 1918 (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16) and RFC 6598 (100.64.0.0/10) through PSC interface. @@ -368,7 +368,7 @@

Method Details

"diskSizeGb": "A String", # Size of the disk attached to the worker, in GB. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). Specify a value of up to 4000. If `0` is specified, Cloud Build will use a standard disk size. "enableNestedVirtualization": True or False, # Optional. Enable nested virtualization on the worker, if supported by the machine type. By default, nested virtualization is disabled. "machineType": "A String", # Optional. Machine type of a worker, such as `e2-medium`. See [Worker pool config file](https://cloud.google.com/build/docs/private-pools/worker-pool-config-file-schema). If left blank, Cloud Build will use a sensible default. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. + "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning worker VMs. The pool's requirements will be matched to a [pre-sized machine type](/compute/docs/general-purpose-machines) which is available in the pool's region. If left blank, Cloud Build will use a sensible default. "A String", ], "workerRelease": "A String", # Optional. Option to specify which release or release channel (rapid|regular|stable) to use to run this build. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index b35da8b107..9c976d7875 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -310,7 +310,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -951,7 +951,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -1620,7 +1620,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -2273,7 +2273,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -2932,7 +2932,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. @@ -3573,7 +3573,7 @@

Method Details

"workerRelease": "A String", # Output only. OUTPUT_ONLY. The release or release channel used to run the Build. This is set to the same value as `PrivatePoolV1Config.WorkerConfig.worker_release` for the UI to easily access. }, "pubsubTopic": "A String", # Optional. Option to specify the Pub/Sub topic to receive build status updates. - "rankedMachineSeries": [ # Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM. + "rankedMachineSeries": [ # Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect. "A String", ], "requestedVerifyOption": "A String", # Requested verifiability options. diff --git a/docs/dyn/cloudnumberregistry_v1alpha.organizations.locations.orgNumberRegistries.html b/docs/dyn/cloudnumberregistry_v1alpha.organizations.locations.orgNumberRegistries.html index 3eb06321bc..9550fd543c 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.organizations.locations.orgNumberRegistries.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.organizations.locations.orgNumberRegistries.html @@ -249,7 +249,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the OrgNumberRegistry was last updated. }, ], - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], }
diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.customRanges.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.customRanges.html index 7400d41abc..48470265a7 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.customRanges.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.customRanges.html @@ -118,12 +118,12 @@

Method Details

{ # A CustomRange represents a user-defined IP address range. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -243,12 +243,12 @@

Method Details

{ # A CustomRange represents a user-defined IP address range. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -283,12 +283,12 @@

Method Details

"customRanges": [ # The list of CustomRanges. { # A CustomRange represents a user-defined IP address range. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -301,7 +301,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], }
@@ -332,12 +332,12 @@

Method Details

{ # A CustomRange represents a user-defined IP address range. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -397,12 +397,12 @@

Method Details

{ # Response message for the CloudNumberRegistry.ShowCustomRangeUtilization method. "customRange": { # A CustomRange represents a user-defined IP address range. # The CustomRange resource. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.discoveredRanges.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.discoveredRanges.html index 147310ccd1..83bbb0700a 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.discoveredRanges.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.discoveredRanges.html @@ -138,7 +138,7 @@

Method Details

{ # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. "attributes": [ # Optional. The attributes of the DiscoveredRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, @@ -191,7 +191,7 @@

Method Details

"discoveredRanges": [ # The list of DiscoveredRanges. { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. "attributes": [ # Optional. The attributes of the DiscoveredRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, @@ -222,7 +222,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], }
@@ -259,7 +259,7 @@

Method Details

{ # Response message for the CloudNumberRegistry.ShowDiscoveredRangeUtilization method. "discoveredRange": { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. # The DiscoveredRange resource. "attributes": [ # Optional. The attributes of the DiscoveredRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.ipamAdminScopes.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.ipamAdminScopes.html index 52990f4c43..f19b4986e5 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.ipamAdminScopes.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.ipamAdminScopes.html @@ -381,7 +381,7 @@

Method Details

}, ], "nextPageToken": "A String", # A token to retrieve the next page of results, or empty if there are no more results in the list. - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], } diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html index 4eac555096..d1897372d3 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.realms.html @@ -307,7 +307,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the Realm was last updated. }, ], - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], } diff --git a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html index 0ef75b2d1f..8f9caa169f 100644 --- a/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html +++ b/docs/dyn/cloudnumberregistry_v1alpha.projects.locations.registryBooks.html @@ -313,7 +313,7 @@

Method Details

"updateTime": "A String", # Output only. The time at which the RegistryBook was last updated. }, ], - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], } @@ -434,12 +434,12 @@

Method Details

{ # Represents either a CustomRange or a DiscoveredRange. "customRange": { # A CustomRange represents a user-defined IP address range. # A CustomRange. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -452,7 +452,7 @@

Method Details

}, "discoveredRange": { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. # A DiscoveredRange. "attributes": [ # Optional. The attributes of the DiscoveredRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, @@ -493,12 +493,12 @@

Method Details

"range": { # Represents either a CustomRange or a DiscoveredRange. # A Range matching the search query. "customRange": { # A CustomRange represents a user-defined IP address range. # A CustomRange. "attributes": [ # Optional. The attributes of the CustomRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, ], - "description": "A String", # Optional. The description of the CustomRange. + "description": "A String", # Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field. "ipv4CidrRange": "A String", # Optional. The IPv4 CIDR range of the CustomRange. "ipv6CidrRange": "A String", # Optional. The IPv6 CIDR range of the CustomRange. "labels": { # Optional. User-defined labels. @@ -511,7 +511,7 @@

Method Details

}, "discoveredRange": { # A DiscoveredRange represents an IP address range automatically detected by the discovery pipeline. # A DiscoveredRange. "attributes": [ # Optional. The attributes of the DiscoveredRange. - { # A key-value pair representing a custom attribute associated with a resource. + { # A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`. "key": "A String", # Required. The key of the attribute. "value": "A String", # Required. The value of the attribute. }, @@ -574,7 +574,7 @@

Method Details

}, }, ], - "unreachable": [ # Locations that could not be reached. + "unreachable": [ # Unordered list. Locations that could not be reached. "A String", ], } diff --git a/docs/dyn/compute_alpha.advice.html b/docs/dyn/compute_alpha.advice.html index 132e82aa4f..9d8abe5639 100644 --- a/docs/dyn/compute_alpha.advice.html +++ b/docs/dyn/compute_alpha.advice.html @@ -328,8 +328,10 @@

Method Details

# VMs that have interconnected GPUs or TPUs. # Example values: 2x2 for ct5l-hightpu-4t. "scheduling": { # Defines the instance scheduling options. # Specifies the scheduling options. - "maxRunDuration": "A String", # The maximum time that instances can run before Compute Engine - # terminates them. + "maxRunDuration": "A String", # Optional. The maximum time that instances can run before Compute Engine + # terminates them. If you set the `provisioning_model` to `FLEX_START`, + # then Compute Engine requires this duration, and the value must be + # between 10 minutes and 7 days. "provisioningModel": "A String", # Specifies the provisioning model. }, }, @@ -352,8 +354,9 @@

Method Details

"estimatedUptime": "A String", # The estimated run time of the majority of Spot VMs in the request # before preemption. The estimate is best-effort only. It is based on # historical data and current conditions. - "estimatedWaitDuration": "A String", # Output only. The likely maximum time that you will have to wait until - # Compute Engine provisions your instances. + "estimatedWaitDuration": "A String", # Output only. The estimated time you have to wait before Compute Engine provisions + # your instances. The value 999999999s indicates that the wait time is + # unknown or very long. "obtainability": 3.14, # The obtainability score indicates the likelihood of successfully # obtaining (provisioning) the requested number of VMs. # The score range is 0.0 through 1.0. Higher is better. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 2900be701a..9f79bff479 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -1227,9 +1227,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -3754,9 +3751,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -6773,9 +6767,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -8981,9 +8972,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -10923,9 +10911,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -12805,9 +12790,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -16469,9 +16451,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 1631dc1097..379a73a175 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -1100,9 +1100,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -3342,9 +3339,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -5551,9 +5545,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -7495,9 +7486,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -9378,9 +9366,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # @@ -12729,9 +12714,6 @@

Method Details

# Advertisement(RA) packet (IPv6). Google Cloud immediately but # temporarily associates the forwarding rule IP address with that VM, and # both new and in-flight packets are quickly delivered to that VM. - # - HA_CONTROLLER: The Backend Service is managed by a High Availability - # Controller. Failover and leader election are exclusively managed by the - # HA Controller service. # # # diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html index ea2ea8d8b2..c366448d83 100644 --- a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.html @@ -74,6 +74,11 @@

Contact Center AI Platform API . projects . locations . contactCenters

Instance Methods

+

+ phoneNumbers() +

+

Returns the phoneNumbers Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.phoneNumbers.html b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.phoneNumbers.html new file mode 100644 index 0000000000..8d0148fe6d --- /dev/null +++ b/docs/dyn/contactcenteraiplatform_v1alpha1.projects.locations.contactCenters.phoneNumbers.html @@ -0,0 +1,142 @@ + + + +

Contact Center AI Platform API . projects . locations . contactCenters . phoneNumbers

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists phone numbers allocated to a single ContactCenter.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists phone numbers allocated to a single ContactCenter.
+
+Args:
+  parent: string, Required. The parent ContactCenter resource name. Format: projects/{project}/locations/{location}/contactCenters/{contact_center} (required)
+  pageSize: integer, Optional. Requested page size. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the default page size is 500.
+  pageToken: string, Optional. Page token from a previous ListPhoneNumbers call.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListPhoneNumbers.
+  "nextPageToken": "A String", # Token identifying the next page of results.
+  "phoneNumbers": [ # The list of phone numbers allocated to the ContactCenter.
+    { # Message describing a phone number allocated to a ContactCenter tenant.
+      "assignmentState": "A String", # Output only. Current assignment and lifecycle state.
+      "carrier": "A String", # Output only. Underlying carrier hosting the number.
+      "complianceState": "A String", # Output only. Regulatory compliance state.
+      "countryCode": "A String", # Output only. ISO 3166-1 alpha-2 country code (e.g., "US", "GB", "IT").
+      "createTime": "A String", # Output only. Timestamp when the phone number was added to the tenant.
+      "numberType": "A String", # Output only. Tariff and routing classification.
+      "phoneNumber": "A String", # Output only. E.164 formatted phone number (e.g., "+16502530000").
+      "regulatoryBundleId": "A String", # Output only. Reference ID for the country-specific regulatory bundle, or "LEGACY_VERIFIED".
+      "smsState": "A String", # Output only. SMS capability state.
+      "updateTime": "A String", # Output only. Timestamp when the phone number record was last modified.
+      "voiceEnabled": True or False, # Output only. Whether voice capabilities are enabled for this phone number.
+    },
+  ],
+}
+
+ +
+ 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/dataform_v1.projects.locations.repositories.workspaces.html b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html index 1a036546a0..cc6ca53876 100644 --- a/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html +++ b/docs/dyn/dataform_v1.projects.locations.repositories.workspaces.html @@ -83,6 +83,9 @@

Instance Methods

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

Creates a new Workspace in a given Repository.

+

+ createLongRunning(parent, body=None, workspaceId=None, x__xgafv=None)

+

Creates a new Workspace in a given Repository asynchronously.

delete(name, x__xgafv=None)

Deletes a single Workspace.

@@ -241,6 +244,58 @@

Method Details

}
+
+ createLongRunning(parent, body=None, workspaceId=None, x__xgafv=None) +
Creates a new Workspace in a given Repository asynchronously.
+
+Args:
+  parent: string, Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Dataform Git workspace.
+  "createTime": "A String", # Output only. The timestamp of when the workspace was created.
+  "dataEncryptionState": { # Describes encryption state of a resource. # Output only. A data encryption state of a Git repository if this Workspace is protected by a KMS key.
+    "kmsKeyVersionName": "A String", # Required. The KMS key version name with which data of a resource is encrypted.
+  },
+  "disableMoves": True or False, # Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted.
+  "internalMetadata": "A String", # Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
+  "name": "A String", # Identifier. The workspace's name.
+  "privateResourceMetadata": { # Metadata used to identify if a resource is user scoped. # Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`.
+    "userScoped": True or False, # Output only. If true, this resource is user-scoped, meaning it is either a workspace or sourced from a workspace.
+  },
+}
+
+  workspaceId: string, Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+
delete(name, x__xgafv=None)
Deletes a single Workspace.
diff --git a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html
index 22565aed0a..3f57e54829 100644
--- a/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html
+++ b/docs/dyn/datastream_v1.projects.locations.connectionProfiles.html
@@ -220,7 +220,7 @@ 

Method Details

"secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field. "username": "A String", # Required. Username for the Oracle connection. }, - "postgresqlProfile": { # Profile for connecting to a PostgreSQL source. # Profile for connecting to a PostgreSQL source. + "postgresqlProfile": { # Profile for connecting to a PostgreSQL source or destination. # Profile for connecting to a PostgreSQL source or destination. "database": "A String", # Required. Database for the PostgreSQL connection. "hostname": "A String", # Required. Hostname for the PostgreSQL connection. "password": "A String", # Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field. @@ -517,7 +517,7 @@

Method Details

"secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field. "username": "A String", # Required. Username for the Oracle connection. }, - "postgresqlProfile": { # Profile for connecting to a PostgreSQL source. # Profile for connecting to a PostgreSQL source. + "postgresqlProfile": { # Profile for connecting to a PostgreSQL source or destination. # Profile for connecting to a PostgreSQL source or destination. "database": "A String", # Required. Database for the PostgreSQL connection. "hostname": "A String", # Required. Hostname for the PostgreSQL connection. "password": "A String", # Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field. @@ -1095,7 +1095,7 @@

Method Details

"secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field. "username": "A String", # Required. Username for the Oracle connection. }, - "postgresqlProfile": { # Profile for connecting to a PostgreSQL source. # Profile for connecting to a PostgreSQL source. + "postgresqlProfile": { # Profile for connecting to a PostgreSQL source or destination. # Profile for connecting to a PostgreSQL source or destination. "database": "A String", # Required. Database for the PostgreSQL connection. "hostname": "A String", # Required. Hostname for the PostgreSQL connection. "password": "A String", # Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field. @@ -1334,7 +1334,7 @@

Method Details

"secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field. "username": "A String", # Required. Username for the Oracle connection. }, - "postgresqlProfile": { # Profile for connecting to a PostgreSQL source. # Profile for connecting to a PostgreSQL source. + "postgresqlProfile": { # Profile for connecting to a PostgreSQL source or destination. # Profile for connecting to a PostgreSQL source or destination. "database": "A String", # Required. Database for the PostgreSQL connection. "hostname": "A String", # Required. Hostname for the PostgreSQL connection. "password": "A String", # Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field. @@ -1582,7 +1582,7 @@

Method Details

"secretManagerStoredPassword": "A String", # Optional. A reference to a Secret Manager resource name storing the Oracle connection password. Mutually exclusive with the `password` field. "username": "A String", # Required. Username for the Oracle connection. }, - "postgresqlProfile": { # Profile for connecting to a PostgreSQL source. # Profile for connecting to a PostgreSQL source. + "postgresqlProfile": { # Profile for connecting to a PostgreSQL source or destination. # Profile for connecting to a PostgreSQL source or destination. "database": "A String", # Required. Database for the PostgreSQL connection. "hostname": "A String", # Required. Hostname for the PostgreSQL connection. "password": "A String", # Optional. Password for the PostgreSQL connection. Mutually exclusive with the `secret_manager_stored_password` field. diff --git a/docs/dyn/deploymentmanager_alpha.compositeTypes.html b/docs/dyn/deploymentmanager_alpha.compositeTypes.html index 1dc60933f7..55d4851638 100644 --- a/docs/dyn/deploymentmanager_alpha.compositeTypes.html +++ b/docs/dyn/deploymentmanager_alpha.compositeTypes.html @@ -195,6 +195,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -214,6 +223,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -224,6 +234,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -380,6 +406,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -399,6 +434,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -409,6 +445,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -573,6 +625,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -592,6 +653,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -602,6 +664,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -754,6 +832,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -773,6 +860,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -783,6 +871,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -943,6 +1047,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -962,6 +1075,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -972,6 +1086,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1154,6 +1284,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1173,6 +1312,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1183,6 +1323,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1335,6 +1491,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1354,6 +1519,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1364,6 +1530,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1514,6 +1696,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1533,6 +1724,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1543,6 +1735,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1695,6 +1903,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1714,6 +1931,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1724,6 +1942,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_alpha.deployments.html b/docs/dyn/deploymentmanager_alpha.deployments.html index 21acb2fce1..3577e3468d 100644 --- a/docs/dyn/deploymentmanager_alpha.deployments.html +++ b/docs/dyn/deploymentmanager_alpha.deployments.html @@ -211,6 +211,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -230,6 +239,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -240,6 +250,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -394,6 +420,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -413,6 +448,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -423,6 +459,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -591,6 +643,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -610,6 +671,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -620,6 +682,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -871,6 +949,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -890,6 +977,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -900,6 +988,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1083,6 +1187,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1102,6 +1215,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1112,6 +1226,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1284,6 +1414,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1303,6 +1442,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1313,6 +1453,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1532,6 +1688,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1551,6 +1716,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1561,6 +1727,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1748,6 +1930,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1767,6 +1958,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1777,6 +1969,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2029,6 +2237,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2048,6 +2265,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2058,6 +2276,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2252,6 +2486,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2271,6 +2514,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2281,6 +2525,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2468,6 +2728,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2487,6 +2756,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2497,6 +2767,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_alpha.operations.html b/docs/dyn/deploymentmanager_alpha.operations.html index 7aee55ffed..3844ef602d 100644 --- a/docs/dyn/deploymentmanager_alpha.operations.html +++ b/docs/dyn/deploymentmanager_alpha.operations.html @@ -183,6 +183,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -202,6 +211,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -212,6 +222,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -362,6 +388,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -381,6 +416,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -391,6 +427,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_alpha.typeProviders.html b/docs/dyn/deploymentmanager_alpha.typeProviders.html index 6d207ebea9..6d68271170 100644 --- a/docs/dyn/deploymentmanager_alpha.typeProviders.html +++ b/docs/dyn/deploymentmanager_alpha.typeProviders.html @@ -204,6 +204,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -223,6 +232,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -233,6 +243,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -447,6 +473,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -466,6 +501,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -476,6 +512,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -748,6 +800,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -767,6 +828,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -777,6 +839,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -948,6 +1026,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -967,6 +1054,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -977,6 +1065,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1196,6 +1300,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1215,6 +1328,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1225,6 +1339,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1535,6 +1665,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1554,6 +1693,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1564,6 +1704,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1735,6 +1891,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1754,6 +1919,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1764,6 +1930,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1972,6 +2154,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1991,6 +2182,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2001,6 +2193,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2172,6 +2380,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2191,6 +2408,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2201,6 +2419,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_alpha.types.html b/docs/dyn/deploymentmanager_alpha.types.html index 477ba91a55..0f9c569e5d 100644 --- a/docs/dyn/deploymentmanager_alpha.types.html +++ b/docs/dyn/deploymentmanager_alpha.types.html @@ -283,6 +283,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -302,6 +311,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -312,6 +322,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -564,6 +590,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -583,6 +618,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -593,6 +629,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2.deployments.html b/docs/dyn/deploymentmanager_v2.deployments.html index 9328348bc6..7d7b2c3439 100644 --- a/docs/dyn/deploymentmanager_v2.deployments.html +++ b/docs/dyn/deploymentmanager_v2.deployments.html @@ -211,6 +211,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -230,6 +239,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -240,6 +250,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -394,6 +420,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -413,6 +448,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -423,6 +459,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -581,6 +633,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -600,6 +661,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -610,6 +672,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -835,6 +913,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -854,6 +941,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -864,6 +952,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1030,6 +1134,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1049,6 +1162,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1059,6 +1173,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1221,6 +1351,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1240,6 +1379,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1250,6 +1390,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1443,6 +1599,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1462,6 +1627,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1472,6 +1638,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1642,6 +1824,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1661,6 +1852,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1671,6 +1863,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1923,6 +2131,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1942,6 +2159,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1952,6 +2170,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2136,6 +2370,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2155,6 +2398,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2165,6 +2409,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2335,6 +2595,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2354,6 +2623,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2364,6 +2634,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2.operations.html b/docs/dyn/deploymentmanager_v2.operations.html index cac589b5e8..54f6597a56 100644 --- a/docs/dyn/deploymentmanager_v2.operations.html +++ b/docs/dyn/deploymentmanager_v2.operations.html @@ -183,6 +183,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -202,6 +211,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -212,6 +222,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -362,6 +388,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -381,6 +416,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -391,6 +427,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2.types.html b/docs/dyn/deploymentmanager_v2.types.html index e153099f8f..3c9ed0474e 100644 --- a/docs/dyn/deploymentmanager_v2.types.html +++ b/docs/dyn/deploymentmanager_v2.types.html @@ -189,6 +189,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -208,6 +217,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -218,6 +228,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2beta.compositeTypes.html b/docs/dyn/deploymentmanager_v2beta.compositeTypes.html index 2fdde8ce12..a9896d1121 100644 --- a/docs/dyn/deploymentmanager_v2beta.compositeTypes.html +++ b/docs/dyn/deploymentmanager_v2beta.compositeTypes.html @@ -195,6 +195,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -214,6 +223,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -224,6 +234,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -380,6 +406,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -399,6 +434,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -409,6 +445,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -573,6 +625,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -592,6 +653,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -602,6 +664,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -754,6 +832,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -773,6 +860,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -783,6 +871,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -943,6 +1047,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -962,6 +1075,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -972,6 +1086,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1154,6 +1284,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1173,6 +1312,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1183,6 +1323,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1335,6 +1491,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1354,6 +1519,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1364,6 +1530,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1514,6 +1696,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1533,6 +1724,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1543,6 +1735,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1695,6 +1903,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1714,6 +1931,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1724,6 +1942,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2beta.deployments.html b/docs/dyn/deploymentmanager_v2beta.deployments.html index ce7e75f6d7..eb908ada30 100644 --- a/docs/dyn/deploymentmanager_v2beta.deployments.html +++ b/docs/dyn/deploymentmanager_v2beta.deployments.html @@ -211,6 +211,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -230,6 +239,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -240,6 +250,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -394,6 +420,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -413,6 +448,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -423,6 +459,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -581,6 +633,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -600,6 +661,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -610,6 +672,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -835,6 +913,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -854,6 +941,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -864,6 +952,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1031,6 +1135,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1050,6 +1163,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1060,6 +1174,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1222,6 +1352,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1241,6 +1380,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1251,6 +1391,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1444,6 +1600,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1463,6 +1628,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1473,6 +1639,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1644,6 +1826,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1663,6 +1854,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1673,6 +1865,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1925,6 +2133,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1944,6 +2161,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1954,6 +2172,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2138,6 +2372,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2157,6 +2400,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2167,6 +2411,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2338,6 +2598,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2357,6 +2626,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2367,6 +2637,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2beta.operations.html b/docs/dyn/deploymentmanager_v2beta.operations.html index d1968fd5e7..82bbda9de4 100644 --- a/docs/dyn/deploymentmanager_v2beta.operations.html +++ b/docs/dyn/deploymentmanager_v2beta.operations.html @@ -183,6 +183,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -202,6 +211,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -212,6 +222,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -362,6 +388,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -381,6 +416,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -391,6 +427,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2beta.typeProviders.html b/docs/dyn/deploymentmanager_v2beta.typeProviders.html index ef4dab3059..a6196c8698 100644 --- a/docs/dyn/deploymentmanager_v2beta.typeProviders.html +++ b/docs/dyn/deploymentmanager_v2beta.typeProviders.html @@ -204,6 +204,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -223,6 +232,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -233,6 +243,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -440,6 +466,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -459,6 +494,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -469,6 +505,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -734,6 +786,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -753,6 +814,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -763,6 +825,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -934,6 +1012,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -953,6 +1040,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -963,6 +1051,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1175,6 +1279,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1194,6 +1307,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1204,6 +1318,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1507,6 +1637,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1526,6 +1665,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1536,6 +1676,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1707,6 +1863,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1726,6 +1891,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1736,6 +1902,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -1937,6 +2119,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -1956,6 +2147,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -1966,6 +2158,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. @@ -2137,6 +2345,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -2156,6 +2373,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -2166,6 +2384,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/deploymentmanager_v2beta.types.html b/docs/dyn/deploymentmanager_v2beta.types.html index d7a6ca4e88..2574939716 100644 --- a/docs/dyn/deploymentmanager_v2beta.types.html +++ b/docs/dyn/deploymentmanager_v2beta.types.html @@ -278,6 +278,15 @@

Method Details

}, }, "getVersionOperationMetadata": { + "inlineHbomInfo": { + "hardwareComponentInfo": { # A mapping of hardware sub-component categories to their component values. + "a_key": { + "values": [ # List of obfuscated hardware component identifiers. + "A String", + ], + }, + }, + }, "inlineSbomInfo": { "currentComponentVersions": { # A mapping of components to their currently-applied versions or other appropriate identifiers. "a_key": "A String", @@ -297,6 +306,7 @@

Method Details

"a_key": { "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "estimatedAvailabilityTime": "A String", # Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes. "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. @@ -307,6 +317,22 @@

Method Details

"troubleshootOutput": "A String", # Output only. [Output Only] Serialized output of the troubleshooting diagnostic run. }, "kind": "compute#operation", # Output only. [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "microVmsExportOperationMetadata": { # [Output Only] Operation metadata for microVms.export. # Output only. [Output Only] Operation metadata for microVms.export. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the exported archive. + "bucketName": "A String", # Output only. [Output Only] Target Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred to Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files archived. + "objectName": "A String", # Output only. [Output Only] Target Cloud Storage object name or prefix. + }, + "microVmsImportOperationMetadata": { # [Output Only] Operation metadata for microVms.import. # Output only. [Output Only] Operation metadata for microVms.import. + "archiveSha256": "A String", # Output only. [Output Only] SHA-256 hex digest of the imported archive. + "bucketName": "A String", # Output only. [Output Only] Source Cloud Storage bucket name. + "bytesTransferred": "A String", # Output only. [Output Only] Total bytes transferred from Cloud Storage. + "filesTransferred": "A String", # Output only. [Output Only] Total files imported. + "objectName": "A String", # Output only. [Output Only] Source Cloud Storage object name or prefix. + "phase": "A String", # Output only. [Output Only] The current phase of the import operation. + "totalBytes": "A String", # Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC. + }, "name": "A String", # [Output Only] Name of the operation. "operationGroupId": "A String", # Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. diff --git a/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html b/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html index 6f49d8993a..df5b35afa1 100644 --- a/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html +++ b/docs/dyn/developerconnect_v1.projects.locations.connections.gitRepositoryLinks.html @@ -200,10 +200,10 @@

Method Details

The object takes the form of: { # Request message for AddGitRepositoryLinkPullRequestReviewComment. - "comment": { # Message representing a SCM Pull Request Review Comment (inline on diff). # Required. The review comment to add. + "comment": { # Message representing a SCM Pull Request Review Comment (inline on diff). # Required. The review comment to add. Input fields used: `body`, `path`, `first_line`, `last_line`, `side`. "author": "A String", # Output only. The username of the author. "body": "A String", # Required. The body of the comment. - "commitId": "A String", # Output only. The commit SHA the comment was actually applied to. + "commitId": "A String", # Output only. The commit SHA the comment was actually applied to. Ignored in requests; to choose the commit to comment on, set `AddGitRepositoryLinkPullRequestReviewCommentRequest.commit_id`. "createTime": "A String", # Output only. When the comment was created. "firstLine": 42, # Optional. The first line of the comment range (inclusive). If not specified, the comment applies only to the `last_line`. "id": "A String", # Output only. The ID of the comment. @@ -212,7 +212,7 @@

Method Details

"side": "A String", # Optional. The side of the diff to comment on. Defaults to HEAD. "updateTime": "A String", # Output only. When the comment was updated. }, - "commitId": "A String", # Optional. The commit SHA to comment on. If not specified, defaults to the HEAD commit of the Pull Request. + "commitId": "A String", # Optional. The SHA of a commit in the pull request to comment on. If not specified, defaults to the HEAD commit of the pull request. Set this only to comment on a specific, known commit in the pull request. "pullRequestId": "A String", # Required. The ID of the Pull Request. } @@ -227,7 +227,7 @@

Method Details

{ # Message representing a SCM Pull Request Review Comment (inline on diff). "author": "A String", # Output only. The username of the author. "body": "A String", # Required. The body of the comment. - "commitId": "A String", # Output only. The commit SHA the comment was actually applied to. + "commitId": "A String", # Output only. The commit SHA the comment was actually applied to. Ignored in requests; to choose the commit to comment on, set `AddGitRepositoryLinkPullRequestReviewCommentRequest.commit_id`. "createTime": "A String", # Output only. When the comment was created. "firstLine": 42, # Optional. The first line of the comment range (inclusive). If not specified, the comment applies only to the `last_line`. "id": "A String", # Output only. The ID of the comment. @@ -346,7 +346,7 @@

Method Details

Diff commits for a GitRepositoryLink.
 
 Args:
-  name: string, Required. The resource name of the GitRepositoryLink. (required)
+  name: string, Required. The resource name of the GitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`. (required)
   baseSha: string, Required. The base commit SHA or ref.
   headSha: string, Required. The head commit SHA or ref.
   pathFilters: string, Optional. Path patterns or exact paths to filter returned files. When `path_filters` is specified, `FileDiff.patch` is populated for all matching files (use `["**"]` to include patches for all changed files). When `path_filters` is omitted or empty, the full list of `FileDiff` is returned without patch diffs (`FileDiff.patch` is empty). (repeated)
@@ -556,14 +556,14 @@ 

Method Details

{ # Message representing a SCM Pull Request. "author": "A String", # Output only. The username of the author. - "baseRef": "A String", # Required. The target commit SHA of the base branch. + "baseRef": "A String", # Required. The name of the target (base) branch that the changes are merged into. "body": "A String", # Optional. The body description of the PR. "closeTime": "A String", # Output only. When the PR was closed. "createTime": "A String", # Output only. When the PR was created. "declineTime": "A String", # Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is `CLOSED`. - "headRef": "A String", # Required. The source commit SHA of the head branch. + "headRef": "A String", # Required. The name of the source (head) branch that contains the changes. "htmlUrl": "A String", # Output only. The HTML URL of the pull request on the SCM provider. - "id": "A String", # Required. The ID of the PR. + "id": "A String", # Optional. The ID of the PR, assigned by the SCM provider (for example, "45"). Ignored by `OpenGitRepositoryLinkPullRequest`. "mergeTime": "A String", # Output only. When the PR was merged. "mergeability": "A String", # Output only. The mergeability state of the pull request. "state": "A String", # Output only. The current state of the PR. @@ -594,14 +594,14 @@

Method Details

"pullRequests": [ # The list of pull requests. { # Message representing a SCM Pull Request. "author": "A String", # Output only. The username of the author. - "baseRef": "A String", # Required. The target commit SHA of the base branch. + "baseRef": "A String", # Required. The name of the target (base) branch that the changes are merged into. "body": "A String", # Optional. The body description of the PR. "closeTime": "A String", # Output only. When the PR was closed. "createTime": "A String", # Output only. When the PR was created. "declineTime": "A String", # Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is `CLOSED`. - "headRef": "A String", # Required. The source commit SHA of the head branch. + "headRef": "A String", # Required. The name of the source (head) branch that contains the changes. "htmlUrl": "A String", # Output only. The HTML URL of the pull request on the SCM provider. - "id": "A String", # Required. The ID of the PR. + "id": "A String", # Optional. The ID of the PR, assigned by the SCM provider (for example, "45"). Ignored by `OpenGitRepositoryLinkPullRequest`. "mergeTime": "A String", # Output only. When the PR was merged. "mergeability": "A String", # Output only. The mergeability state of the pull request. "state": "A String", # Output only. The current state of the PR. @@ -801,14 +801,14 @@

Method Details

{ # Message representing a SCM Pull Request. "author": "A String", # Output only. The username of the author. - "baseRef": "A String", # Required. The target commit SHA of the base branch. + "baseRef": "A String", # Required. The name of the target (base) branch that the changes are merged into. "body": "A String", # Optional. The body description of the PR. "closeTime": "A String", # Output only. When the PR was closed. "createTime": "A String", # Output only. When the PR was created. "declineTime": "A String", # Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is `CLOSED`. - "headRef": "A String", # Required. The source commit SHA of the head branch. + "headRef": "A String", # Required. The name of the source (head) branch that contains the changes. "htmlUrl": "A String", # Output only. The HTML URL of the pull request on the SCM provider. - "id": "A String", # Required. The ID of the PR. + "id": "A String", # Optional. The ID of the PR, assigned by the SCM provider (for example, "45"). Ignored by `OpenGitRepositoryLinkPullRequest`. "mergeTime": "A String", # Output only. When the PR was merged. "mergeability": "A String", # Output only. The mergeability state of the pull request. "state": "A String", # Output only. The current state of the PR. @@ -829,14 +829,14 @@

Method Details

{ # Message for opening SCM Pull Request. "pullRequest": { # Message representing a SCM Pull Request. # Required. The Pull Request details to open. Input fields used: title, body, head_ref, base_ref. "author": "A String", # Output only. The username of the author. - "baseRef": "A String", # Required. The target commit SHA of the base branch. + "baseRef": "A String", # Required. The name of the target (base) branch that the changes are merged into. "body": "A String", # Optional. The body description of the PR. "closeTime": "A String", # Output only. When the PR was closed. "createTime": "A String", # Output only. When the PR was created. "declineTime": "A String", # Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is `CLOSED`. - "headRef": "A String", # Required. The source commit SHA of the head branch. + "headRef": "A String", # Required. The name of the source (head) branch that contains the changes. "htmlUrl": "A String", # Output only. The HTML URL of the pull request on the SCM provider. - "id": "A String", # Required. The ID of the PR. + "id": "A String", # Optional. The ID of the PR, assigned by the SCM provider (for example, "45"). Ignored by `OpenGitRepositoryLinkPullRequest`. "mergeTime": "A String", # Output only. When the PR was merged. "mergeability": "A String", # Output only. The mergeability state of the pull request. "state": "A String", # Output only. The current state of the PR. @@ -855,14 +855,14 @@

Method Details

{ # Message representing a SCM Pull Request. "author": "A String", # Output only. The username of the author. - "baseRef": "A String", # Required. The target commit SHA of the base branch. + "baseRef": "A String", # Required. The name of the target (base) branch that the changes are merged into. "body": "A String", # Optional. The body description of the PR. "closeTime": "A String", # Output only. When the PR was closed. "createTime": "A String", # Output only. When the PR was created. "declineTime": "A String", # Output only. When the PR was declined. Only set for SCM providers that support declining pull requests. Never set for GitHub, GitHub Enterprise, GitLab, or GitLab Enterprise, where a pull request closed without being merged is `CLOSED`. - "headRef": "A String", # Required. The source commit SHA of the head branch. + "headRef": "A String", # Required. The name of the source (head) branch that contains the changes. "htmlUrl": "A String", # Output only. The HTML URL of the pull request on the SCM provider. - "id": "A String", # Required. The ID of the PR. + "id": "A String", # Optional. The ID of the PR, assigned by the SCM provider (for example, "45"). Ignored by `OpenGitRepositoryLinkPullRequest`. "mergeTime": "A String", # Output only. When the PR was merged. "mergeability": "A String", # Output only. The mergeability state of the pull request. "state": "A String", # Output only. The current state of the PR. diff --git a/docs/dyn/file_v1.projects.locations.html b/docs/dyn/file_v1.projects.locations.html index 19966fd727..9f24147163 100644 --- a/docs/dyn/file_v1.projects.locations.html +++ b/docs/dyn/file_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the operations Resource.

+

+ volumePools() +

+

Returns the volumePools Resource.

+

close()

Close httplib2 connections.

diff --git a/docs/dyn/file_v1.projects.locations.volumePools.html b/docs/dyn/file_v1.projects.locations.volumePools.html new file mode 100644 index 0000000000..7548fe96d1 --- /dev/null +++ b/docs/dyn/file_v1.projects.locations.volumePools.html @@ -0,0 +1,343 @@ + + + +

Cloud Filestore API . projects . locations . volumePools

+

Instance Methods

+

+ volumes() +

+

Returns the volumes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Creates a volume pool.

+

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

+

Deletes a volume pool.

+

+ get(name, x__xgafv=None)

+

Gets the details of a specific volume pool.

+

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

+

Lists all volume pools in a project for either a specified location or for all locations.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific volume pool.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, volumePoolId=None, x__xgafv=None) +
Creates a volume pool.
+
+Args:
+  parent: string, Required. The project and location for which to create the volume pool, in the format `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # VolumePool representation of a Cloud Filestore volume pool.
+  "activeVolumeCount": 42, # Optional. The number of active volumes. Default: 100.
+  "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume.
+  "autoFreezeDelay": "A String", # Optional. How long a volume stays `WARM` after it is deactivated before it is automatically frozen (moved to `COLD`). Must be positive if set. Default: 7 days.
+  "createTime": "A String", # Output only. The time when the volume pool was created.
+  "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Must be between 100 MiB and 102400 MiB (100 GiB). Default: 1024 MiB.
+  "description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
+  "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.
+  "state": "A String", # Output only. The state of the volume pool.
+  "uid": "A String", # Output only. System-assigned unique identifier for the volume pool.
+}
+
+  volumePoolId: string, Required. The ID to use for the volume pool, which will become the final component of the volume pool's resource name.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, force=None, x__xgafv=None) +
Deletes a volume pool.
+
+Args:
+  name: string, Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
+  force: boolean, Optional. If set to `true`, the volume pool is deleted even if it has volumes, and its volumes are deleted with it. Otherwise, the request fails if the volume pool has any volumes.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of a specific volume pool.
+
+Args:
+  name: string, Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # VolumePool representation of a Cloud Filestore volume pool.
+  "activeVolumeCount": 42, # Optional. The number of active volumes. Default: 100.
+  "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume.
+  "autoFreezeDelay": "A String", # Optional. How long a volume stays `WARM` after it is deactivated before it is automatically frozen (moved to `COLD`). Must be positive if set. Default: 7 days.
+  "createTime": "A String", # Output only. The time when the volume pool was created.
+  "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Must be between 100 MiB and 102400 MiB (100 GiB). Default: 1024 MiB.
+  "description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
+  "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.
+  "state": "A String", # Output only. The state of the volume pool.
+  "uid": "A String", # Output only. System-assigned unique identifier for the volume pool.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all volume pools in a project for either a specified location or for all locations.
+
+Args:
+  parent: string, Required. The project and location for which to retrieve volume pool information, in the format `projects/{project}/locations/{location}`. To retrieve volume pool information for all locations, use "-" as the value of `{location}`. (required)
+  filter: string, Optional. List filter.
+  orderBy: string, Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListVolumePoolsResponse is the result of ListVolumePoolsRequest.
+  "nextPageToken": "A String", # Optional. The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+  "volumePools": [ # Unordered list. A list of volume pools in the project for the specified location.
+    { # VolumePool representation of a Cloud Filestore volume pool.
+      "activeVolumeCount": 42, # Optional. The number of active volumes. Default: 100.
+      "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume.
+      "autoFreezeDelay": "A String", # Optional. How long a volume stays `WARM` after it is deactivated before it is automatically frozen (moved to `COLD`). Must be positive if set. Default: 7 days.
+      "createTime": "A String", # Output only. The time when the volume pool was created.
+      "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Must be between 100 MiB and 102400 MiB (100 GiB). Default: 1024 MiB.
+      "description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
+      "labels": { # Optional. Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
+      "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.
+      "state": "A String", # Output only. The state of the volume pool.
+      "uid": "A String", # Output only. System-assigned unique identifier for the volume pool.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific volume pool.
+
+Args:
+  name: string, Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # VolumePool representation of a Cloud Filestore volume pool.
+  "activeVolumeCount": 42, # Optional. The number of active volumes. Default: 100.
+  "activeVolumeIops": 42, # Optional. The number of IOPs provisioned per active volume.
+  "autoFreezeDelay": "A String", # Optional. How long a volume stays `WARM` after it is deactivated before it is automatically frozen (moved to `COLD`). Must be positive if set. Default: 7 days.
+  "createTime": "A String", # Output only. The time when the volume pool was created.
+  "defaultVolumeQuotaMib": 42, # Optional. The default quota per volume in MiB. Must be between 100 MiB and 102400 MiB (100 GiB). Default: 1024 MiB.
+  "description": "A String", # Optional. A description of the volume pool with 2048 characters or less.
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.
+  "network": "A String", # Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.
+  "state": "A String", # Output only. The state of the volume pool.
+  "uid": "A String", # Output only. System-assigned unique identifier for the volume pool.
+}
+
+  updateMask: string, Optional. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/file_v1.projects.locations.volumePools.volumes.html b/docs/dyn/file_v1.projects.locations.volumePools.volumes.html new file mode 100644 index 0000000000..f480da9f18 --- /dev/null +++ b/docs/dyn/file_v1.projects.locations.volumePools.volumes.html @@ -0,0 +1,496 @@ + + + +

Cloud Filestore API . projects . locations . volumePools . volumes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a volume.

+

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

+

Creates a volume in a volume pool from an existing data source (such as a Filestore backup).

+

+ delete(name, x__xgafv=None)

+

Deletes a volume.

+

+ get(name, x__xgafv=None)

+

Gets the details of a specific volume.

+

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

+

Lists all volumes for a specified volume pool.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

Updates the settings of a specific volume.

+

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

+

Unfreezes a volume.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, volumeId=None, x__xgafv=None) +
Creates a volume.
+
+Args:
+  parent: string, Required. The parent volume pool path, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume representation of a Cloud Filestore volume.
+  "createTime": "A String", # Output only. The time when the volume was created.
+  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+  },
+  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+  "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+  "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+}
+
+  volumeId: string, Required. The ID to use for the volume. The ID must be unique within the specified volume pool.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Volume representation of a Cloud Filestore volume.
+  "createTime": "A String", # Output only. The time when the volume was created.
+  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+  },
+  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+  "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+  "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+}
+
+ +
+ createFromSource(parent, body=None, x__xgafv=None) +
Creates a volume in a volume pool from an existing data source (such as a Filestore backup).
+
+Args:
+  parent: string, Required. The parent resource where this volume will be created. Format: projects/{project}/locations/{location}/volumePools/{volume_pool} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for creating a volume from an existing data source (such as a backup).
+  "backup": "A String", # The resource name of the backup to create from. Format: projects/{project}/locations/{location}/backups/{backup}
+  "ipAcls": [ # Optional. IP ACLs defining permissions/ACLs to apply to the newly created volume.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB.
+  "requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.
+  "volumeId": "A String", # Required. Unique identifier for the volume which also appears in the volumes resource name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a volume.
+
+Args:
+  name: string, Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets the details of a specific volume.
+
+Args:
+  name: string, Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Volume representation of a Cloud Filestore volume.
+  "createTime": "A String", # Output only. The time when the volume was created.
+  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+  },
+  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+  "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+  "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all volumes for a specified volume pool.
+
+Args:
+  parent: string, Required. The volume pool for which to retrieve volume information, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`. (required)
+  filter: string, Optional. List filter.
+  orderBy: string, Optional. Sort results. Supported values are "name", "name desc" or "" (unsorted).
+  pageSize: integer, Optional. The maximum number of items to return.
+  pageToken: string, Optional. The next_page_token value to use if there are additional results to retrieve for this list request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # ListVolumesResponse is the result of ListVolumesRequest.
+  "nextPageToken": "A String", # Optional. The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.
+  "unreachable": [ # Unordered list. Locations that could not be reached.
+    "A String",
+  ],
+  "volumes": [ # Unordered list. A list of volumes in the project for the specified volume pool.
+    { # Volume representation of a Cloud Filestore volume.
+      "createTime": "A String", # Output only. The time when the volume was created.
+      "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+      "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+        { # NFS export options specifications.
+          "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+          "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+          "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+          "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+            "A String",
+          ],
+          "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+          "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+        },
+      ],
+      "labels": { # Optional. Resource labels to represent user provided metadata.
+        "a_key": "A String",
+      },
+      "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+        "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+        "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+      },
+      "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+      "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+      "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the settings of a specific volume.
+
+Args:
+  name: string, Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Volume representation of a Cloud Filestore volume.
+  "createTime": "A String", # Output only. The time when the volume was created.
+  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+  },
+  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+  "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+  "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+}
+
+  updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Volume representation of a Cloud Filestore volume.
+  "createTime": "A String", # Output only. The time when the volume was created.
+  "description": "A String", # Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.
+  "ipAcls": [ # Optional. User-defined permissions protecting mount points.
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "labels": { # Optional. Resource labels to represent user provided metadata.
+    "a_key": "A String",
+  },
+  "mountPoint": { # Mount details for a volume. # Output only. The mount point of the volume.
+    "ipAddress": "A String", # Output only. The IP address of the physical Filestore instance hosting the volume.
+    "mountName": "A String", # Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.
+  },
+  "name": "A String", # Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.
+  "quotaMib": "A String", # Optional. The maximum size of the volume in mebibytes (MiB).
+  "state": "A String", # Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.
+}
+
+ +
+ unfreeze(name, body=None, x__xgafv=None) +
Unfreezes a volume.
+
+Args:
+  name: string, Required. The name of the volume to unfreeze. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for unfreezing a volume.
+  "ipAcls": [ # Optional. IP ACLs defining permissions/ACLs to apply to the unfrozen volume
+    { # NFS export options specifications.
+      "accessMode": "A String", # Either READ_ONLY, for allowing only read requests on the exported directory, or READ_WRITE, for allowing both read and write requests. The default is READ_WRITE.
+      "anonGid": "A String", # An integer representing the anonymous group id with a default value of 65534. Anon_gid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "anonUid": "A String", # An integer representing the anonymous user id with a default value of 65534. Anon_uid may only be set with squash_mode of ROOT_SQUASH. An error will be returned if this field is specified for other squash_mode settings.
+      "ipRanges": [ # List of either an IPv4 addresses in the format `{octet1}.{octet2}.{octet3}.{octet4}` or CIDR ranges in the format `{octet1}.{octet2}.{octet3}.{octet4}/{mask size}` which may mount the file share. Overlapping IP ranges are not allowed, both within and across NfsExportOptions. An error will be returned. The limit is 64 IP ranges/addresses for each FileShareConfig among all NfsExportOptions.
+        "A String",
+      ],
+      "network": "A String", # Optional. The source VPC network for ip_ranges. Required for instances using Private Service Connect, optional otherwise. If provided, must be the same network specified in the `NetworkConfig.network` field.
+      "squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH.
+    },
+  ],
+  "quota": "A String", # Optional. The limit for how much data can be written to this volume, in MiB.
+  "requestId": "A String", # Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 25ae3fca45..cff80e97b4 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -1133,6 +1133,7 @@

Method Details

"mode": "A String", # Optional. Function calling mode. "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field. }, + "includeServerSideToolInvocations": True or False, # Optional. If true, the API response will include the server-side tool calls and responses within the `Content` message. This allows clients to observe the server's tool interactions. "retrievalConfig": { # Retrieval config. # Optional. Retrieval config. "languageCode": "A String", # The language code of the user. "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user. @@ -2101,6 +2102,7 @@

Method Details

"mode": "A String", # Optional. Function calling mode. "streamFunctionCallArguments": True or False, # Optional. When set to true, arguments of a single function call will be streamed out in multiple parts/contents/responses. Partial parameter results will be returned in the `FunctionCall.partial_args` field. }, + "includeServerSideToolInvocations": True or False, # Optional. If true, the API response will include the server-side tool calls and responses within the `Content` message. This allows clients to observe the server's tool interactions. "retrievalConfig": { # Retrieval config. # Optional. Retrieval config. "languageCode": "A String", # The language code of the user. "latLng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # The location of the user. diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index f6c4a453da..9eaf409867 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -1228,6 +1228,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -2961,6 +2962,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -4407,6 +4409,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -5859,6 +5862,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. diff --git a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html index 166103ee36..3571a201bd 100644 --- a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html @@ -1228,6 +1228,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -2990,6 +2991,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -4465,6 +4467,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. @@ -5946,6 +5949,7 @@

Method Details

"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). }, + "testType": "A String", # Optional. The type of ovulation test. }, "oxygenSaturation": { # Captures the user's instantaneous oxygen saturation percentage (SpO2). # Optional. Data for points in the `oxygen-saturation` sample data type collection. "percentage": 3.14, # Required. The oxygen saturation percentage. Must be in the range `[0, 100]`. diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.html b/docs/dyn/iam_v1.locations.workforcePools.providers.html index 1b498df5f0..f6bb702b8b 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.html @@ -133,6 +133,7 @@

Method Details

"attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters. The key must match the regex `^a-zA-Z0-9._{0,31}$`. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters `[a-z0-9_]`. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, + "attributeSyncInterval": "A String", # Optional. An interval that determines how often user attributes are synced from the IdP. Must be between 30 minutes (1800s) and 12 hours (43200s). This configuration is used only when the Google Cloud session length policy is configured. When Google Cloud session length policy is configured and `attribute_sync_interval` is not configured, attributes are synced after a default interval of 12 hours (43200 seconds). "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false. "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. @@ -188,7 +189,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, - "scimUsage": "A String", # Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. + "scimUsage": "A String", # Optional. Gemini Enterprise and Looker only. Specifies whether the workforce identity pool provider uses SCIM-managed groups, or users and groups. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. "vendorType": "A String", # Optional. The vendor type of the third-party identity provider. } @@ -277,6 +278,7 @@

Method Details

"attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters. The key must match the regex `^a-zA-Z0-9._{0,31}$`. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters `[a-z0-9_]`. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, + "attributeSyncInterval": "A String", # Optional. An interval that determines how often user attributes are synced from the IdP. Must be between 30 minutes (1800s) and 12 hours (43200s). This configuration is used only when the Google Cloud session length policy is configured. When Google Cloud session length policy is configured and `attribute_sync_interval` is not configured, attributes are synced after a default interval of 12 hours (43200 seconds). "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false. "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. @@ -332,7 +334,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, - "scimUsage": "A String", # Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. + "scimUsage": "A String", # Optional. Gemini Enterprise and Looker only. Specifies whether the workforce identity pool provider uses SCIM-managed groups, or users and groups. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. "vendorType": "A String", # Optional. The vendor type of the third-party identity provider. }
@@ -363,6 +365,7 @@

Method Details

"attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters. The key must match the regex `^a-zA-Z0-9._{0,31}$`. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters `[a-z0-9_]`. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, + "attributeSyncInterval": "A String", # Optional. An interval that determines how often user attributes are synced from the IdP. Must be between 30 minutes (1800s) and 12 hours (43200s). This configuration is used only when the Google Cloud session length policy is configured. When Google Cloud session length policy is configured and `attribute_sync_interval` is not configured, attributes are synced after a default interval of 12 hours (43200 seconds). "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false. "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. @@ -418,7 +421,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, - "scimUsage": "A String", # Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. + "scimUsage": "A String", # Optional. Gemini Enterprise and Looker only. Specifies whether the workforce identity pool provider uses SCIM-managed groups, or users and groups. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. "vendorType": "A String", # Optional. The vendor type of the third-party identity provider. }, @@ -454,6 +457,7 @@

Method Details

"attributeMapping": { # Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters. The key must match the regex `^a-zA-Z0-9._{0,31}$`. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters `[a-z0-9_]`. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` "a_key": "A String", }, + "attributeSyncInterval": "A String", # Optional. An interval that determines how often user attributes are synced from the IdP. Must be between 30 minutes (1800s) and 12 hours (43200s). This configuration is used only when the Google Cloud session length policy is configured. When Google Cloud session length policy is configured and `attribute_sync_interval` is not configured, attributes are synced after a default interval of 12 hours (43200 seconds). "description": "A String", # Optional. A description of the provider. Cannot exceed 256 characters. "detailedAuditLogging": True or False, # Optional. If true, populates additional debug information in Cloud Audit Logs for this provider. Logged attribute mappings and values can be found in `sts.googleapis.com` data access logs. Default value is false. "disabled": True or False, # Optional. Disables the workforce pool provider. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. @@ -509,7 +513,7 @@

Method Details

"saml": { # Represents a SAML identity provider. # A SAML identity provider configuration. "idpMetadataXml": "A String", # Required. SAML Identity provider configuration metadata xml doc. The xml document should comply with [SAML 2.0 specification](https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). The max size of the acceptable xml document will be bounded to 128k characters. The metadata xml document should satisfy the following constraints: 1) Must contain an Identity Provider Entity ID. 2) Must contain at least one non-expired signing key certificate. 3) For each signing key: a) Valid from should be no more than 7 days from now. b) Valid to should be no more than 25 years in the future. 4) Up to 3 IdP signing keys are allowed in the metadata xml. When updating the provider's metadata xml, at least one non-expired signing key must overlap with the existing metadata. This requirement is skipped if there are no non-expired signing keys present in the existing metadata. }, - "scimUsage": "A String", # Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. + "scimUsage": "A String", # Optional. Gemini Enterprise and Looker only. Specifies whether the workforce identity pool provider uses SCIM-managed groups, or users and groups. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error. "state": "A String", # Output only. The state of the provider. "vendorType": "A String", # Optional. The vendor type of the third-party identity provider. } diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html index 1de90e20ad..71abe7e257 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.html @@ -84,25 +84,25 @@

Instance Methods

Close httplib2 connections.

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

-

Gemini Enterprise only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.

+

Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.

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

-

Gemini Enterprise only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

+

Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.

get(name, x__xgafv=None)

-

Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimTenant.

+

Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimTenant.

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

Gets IAM policies on a WorkforcePool.

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

-

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

+

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

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimTenant.

+

Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimTenant.

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

Sets IAM policies on a WorkforcePool.

@@ -111,7 +111,7 @@

Instance Methods

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

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

-

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

+

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

Method Details

close() @@ -120,27 +120,27 @@

Method Details

create(parent, body=None, workforcePoolProviderScimTenantId=None, x__xgafv=None) -
Gemini Enterprise only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.
+  
Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.
 
 Args:
-  parent: string, Required. Gemini Enterprise only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
+  parent: string, Required. Gemini Enterprise and Looker only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
-  "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
-  "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ```
+{ # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
+  "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
+  "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ```
     "a_key": "A String",
   },
-  "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
-  "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged.
+  "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
+  "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged.
   "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
-  "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant.
+  "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant.
 }
 
-  workforcePoolProviderScimTenantId: string, Required. Gemini Enterprise only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters `[a-z0-9-]`.
+  workforcePoolProviderScimTenantId: string, Required. Gemini Enterprise and Looker only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters `[a-z0-9-]`.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -149,26 +149,26 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }
delete(name, hardDelete=None, x__xgafv=None) -
Gemini Enterprise only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.
+  
Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.
 
 Args:
-  name: string, Required. Gemini Enterprise only. The name of the SCIM tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   hardDelete: boolean, Optional. Deletes the SCIM tenant immediately. This operation cannot be undone.
   x__xgafv: string, V1 error format.
     Allowed values
@@ -178,26 +178,26 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }
get(name, x__xgafv=None) -
Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimTenant.
+  
Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimTenant.
 
 Args:
-  name: string, Required. Gemini Enterprise only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -206,17 +206,17 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }
@@ -278,13 +278,13 @@

Method Details

list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.
+  
Gemini Enterprise and Looker only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.
 
 Args:
-  parent: string, Required. Gemini Enterprise only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
-  pageSize: integer, Optional. Gemini Enterprise only. The maximum number of SCIM tenants to return. If unspecified, at most 50 SCIM tenants will be returned. The maximum value is 100; values above 100 are truncated to 100.
-  pageToken: string, Optional. Gemini Enterprise only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
-  showDeleted: boolean, Optional. Gemini Enterprise only. Whether to return soft-deleted SCIM tenants.
+  parent: string, Required. Gemini Enterprise and Looker only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}' (required)
+  pageSize: integer, Optional. Gemini Enterprise and Looker only. The maximum number of SCIM tenants to return. If unspecified, at most 50 SCIM tenants will be returned. The maximum value is 100; values above 100 are truncated to 100.
+  pageToken: string, Optional. Gemini Enterprise and Looker only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.
+  showDeleted: boolean, Optional. Gemini Enterprise and Looker only. Whether to return soft-deleted SCIM tenants.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -293,20 +293,20 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTenants. - "nextPageToken": "A String", # Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "workforcePoolProviderScimTenants": [ # Output only. Gemini Enterprise only. A list of SCIM tenants. - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Response message for ListWorkforcePoolProviderScimTenants. + "nextPageToken": "A String", # Optional. Gemini Enterprise and Looker only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "workforcePoolProviderScimTenants": [ # Output only. Gemini Enterprise and Looker only. A list of SCIM tenants. + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }, ], }
@@ -328,27 +328,27 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimTenant.
+  
Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimTenant.
 
 Args:
-  name: string, Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
-  "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
-  "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ```
+{ # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.
+  "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/
+  "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ```
     "a_key": "A String",
   },
-  "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters.
-  "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
-  "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged.
+  "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters.
+  "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`
+  "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged.
   "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent.
-  "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant.
+  "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant.
 }
 
-  updateMask: string, Optional. Gemini Enterprise only. The list of fields to update.
+  updateMask: string, Optional. Gemini Enterprise and Looker only. The list of fields to update.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -357,17 +357,17 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }
@@ -488,14 +488,14 @@

Method Details

undelete(name, body=None, x__xgafv=None) -
Gemini Enterprise only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.
+  
Gemini Enterprise and Looker only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.
 
 Args:
-  name: string, Required. Gemini Enterprise only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
+  name: string, Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Gemini Enterprise only. Request message for UndeleteWorkforcePoolProviderScimTenant.
+{ # Gemini Enterprise and Looker only. Request message for UndeleteWorkforcePoolProviderScimTenant.
 }
 
   x__xgafv: string, V1 error format.
@@ -506,17 +506,17 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. - "baseUri": "A String", # Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ - "claimMapping": { # Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` + { # Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments. + "baseUri": "A String", # Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/ + "claimMapping": { # Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { "google.subject": "user.externalId", "google.group": "group.externalId" } ``` "a_key": "A String", }, - "description": "A String", # Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` - "purgeTime": "A String", # Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged. + "description": "A String", # Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}` + "purgeTime": "A String", # Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged. "serviceAgent": "A String", # Output only. Service Agent created by SCIM Tenant API. SCIM tokens created under this tenant will be attached to this service agent. - "state": "A String", # Output only. Gemini Enterprise only. The state of the tenant. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the tenant. }
diff --git a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html index 0d8c2d58bb..885b31878d 100644 --- a/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html +++ b/docs/dyn/iam_v1.locations.workforcePools.providers.scimTenants.tokens.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Gemini Enterprise only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.

+

Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.

delete(name, x__xgafv=None)

-

Gemini Enterprise only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.

+

Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.

get(name, x__xgafv=None)

-

Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimToken.

+

Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimToken.

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

-

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

+

Gemini Enterprise and Looker only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.

list_next(previous_request, previous_response)

Retrieves the next page of results.

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

-

Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimToken.

+

Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimToken.

Method Details

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

Method Details

create(parent, body=None, workforcePoolProviderScimTokenId=None, x__xgafv=None) -
Gemini Enterprise only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
+  
Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.
 
 Args:
-  parent: string, Required. Gemini Enterprise only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
+  parent: string, Required. Gemini Enterprise and Looker only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
-  "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
-  "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
-  "state": "A String", # Output only. Gemini Enterprise only. The state of the token.
+{ # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
+  "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
+  "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
+  "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token.
 }
 
-  workforcePoolProviderScimTokenId: string, Required. Gemini Enterprise only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: `([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))`
+  workforcePoolProviderScimTokenId: string, Required. Gemini Enterprise and Looker only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: `([a-z]([a-z0-9\\-]{2,30}[a-z0-9]))`
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -126,20 +126,20 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. Gemini Enterprise only. The state of the token. + { # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token. }
delete(name, x__xgafv=None) -
Gemini Enterprise only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.
+  
Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.
 
 Args:
-  name: string, Required. Gemini Enterprise only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Required. Gemini Enterprise and Looker only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,20 +148,20 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. Gemini Enterprise only. The state of the token. + { # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token. }
get(name, x__xgafv=None) -
Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimToken.
+  
Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimToken.
 
 Args:
-  name: string, Required. Gemini Enterprise only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Required. Gemini Enterprise and Looker only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -170,23 +170,23 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. Gemini Enterprise only. The state of the token. + { # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token. }
list(parent, pageSize=None, pageToken=None, showDeleted=None, x__xgafv=None) -
Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
+  
Gemini Enterprise and Looker only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.
 
 Args:
-  parent: string, Required. Gemini Enterprise only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
-  pageSize: integer, Optional. Gemini Enterprise only. The maximum number of SCIM tokens to return. If unspecified, at most 2 SCIM tokens will be returned.
-  pageToken: string, Optional. Gemini Enterprise only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
-  showDeleted: boolean, Optional. Gemini Enterprise only. Whether to return soft-deleted SCIM tokens.
+  parent: string, Required. Gemini Enterprise and Looker only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}' (required)
+  pageSize: integer, Optional. Gemini Enterprise and Looker only. The maximum number of SCIM tokens to return. If unspecified, at most 2 SCIM tokens will be returned.
+  pageToken: string, Optional. Gemini Enterprise and Looker only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.
+  showDeleted: boolean, Optional. Gemini Enterprise and Looker only. Whether to return soft-deleted SCIM tokens.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -195,14 +195,14 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTokens. - "nextPageToken": "A String", # Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - "workforcePoolProviderScimTokens": [ # Output only. Gemini Enterprise only. A list of SCIM tokens. - { # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. Gemini Enterprise only. The state of the token. + { # Gemini Enterprise and Looker only. Response message for ListWorkforcePoolProviderScimTokens. + "nextPageToken": "A String", # Optional. Gemini Enterprise and Looker only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + "workforcePoolProviderScimTokens": [ # Output only. Gemini Enterprise and Looker only. A list of SCIM tokens. + { # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token. }, ], }
@@ -224,21 +224,21 @@

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimToken.
+  
Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimToken.
 
 Args:
-  name: string, Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
+  name: string, Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
-  "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.
-  "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
-  "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
-  "state": "A String", # Output only. Gemini Enterprise only. The state of the token.
+{ # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.
+  "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters.
+  "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`
+  "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation.
+  "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token.
 }
 
-  updateMask: string, Optional. Gemini Enterprise only. The list of fields to update.
+  updateMask: string, Optional. Gemini Enterprise and Looker only. The list of fields to update.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -247,11 +247,11 @@ 

Method Details

Returns: An object of the form: - { # Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. - "displayName": "A String", # Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters. - "name": "A String", # Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` - "securityToken": "A String", # Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation. - "state": "A String", # Output only. Gemini Enterprise only. The state of the token. + { # Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests. + "displayName": "A String", # Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters. + "name": "A String", # Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}` + "securityToken": "A String", # Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation. + "state": "A String", # Output only. Gemini Enterprise and Looker only. The state of the token. }
diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 51737ce74a..ce2990a522 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -919,31 +919,18 @@ ## merchantapi * [accounts_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_accounts_v1.html) -* [accounts_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_accounts_v1beta.html) * [conversions_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_conversions_v1.html) -* [conversions_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_conversions_v1beta.html) * [datasources_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_datasources_v1.html) -* [datasources_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_datasources_v1beta.html) * [inventories_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_inventories_v1.html) -* [inventories_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_inventories_v1beta.html) * [issueresolution_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_issueresolution_v1.html) -* [issueresolution_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_issueresolution_v1beta.html) * [lfp_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_lfp_v1.html) -* [lfp_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_lfp_v1beta.html) * [loyaltycustomers_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_loyaltycustomers_v1.html) * [notifications_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_notifications_v1.html) -* [notifications_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_notifications_v1beta.html) * [ordertracking_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_ordertracking_v1.html) -* [ordertracking_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_ordertracking_v1beta.html) * [products_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_products_v1.html) -* [products_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_products_v1beta.html) * [promotions_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_promotions_v1.html) -* [promotions_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_promotions_v1beta.html) * [quota_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_quota_v1.html) -* [quota_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_quota_v1beta.html) * [reports_v1](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_reports_v1.html) -* [reports_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_reports_v1beta.html) -* [reviews_v1beta](http://googleapis.github.io/google-api-python-client/docs/dyn/merchantapi_reviews_v1beta.html) ## metastore @@ -972,6 +959,7 @@ ## mybusinessbusinessinformation * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessbusinessinformation_v1.html) +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/mybusinessbusinessinformation_v1alpha.html) ## mybusinesslodging diff --git a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html index 3815eb61e0..5bd2739387 100644 --- a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html +++ b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html @@ -136,6 +136,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf In case of multiple languages, the English version is preferred. + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -215,6 +217,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf In case of multiple languages, the English version is preferred. + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -300,6 +304,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf In case of multiple languages, the English version is preferred. + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -368,6 +374,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf In case of multiple languages, the English version is preferred. + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html index c34896cec6..19e8ef0709 100644 --- a/docs/dyn/manufacturers_v1.accounts.products.html +++ b/docs/dyn/manufacturers_v1.accounts.products.html @@ -157,6 +157,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the (English if >1 language) certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -171,6 +173,9 @@

Method Details

}, "description": "A String", # The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description. "disclosureDate": "A String", # The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure. + "documentLink": [ # Optional. URLs of PDF documents for the product, such as user manuals or specifications. + "A String", + ], "excludedDestination": [ # A list of excluded destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], @@ -218,6 +223,7 @@

Method Details

"A String", ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. + "itemGroupTitle": "A String", # Optional. The shared title of the product group that this variant belongs to. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. @@ -341,6 +347,7 @@

Method Details

], }, "pattern": "A String", # The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern. + "popularityRank": 3.14, # Optional. The popularity rank of the product from 0.0 (lowest) to 100.0 (highest). "productDetail": [ # The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. { # A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. "attributeName": "A String", # The name of the attribute. @@ -357,6 +364,19 @@

Method Details

"productType": [ # The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype. "A String", ], + "questionAndAnswer": [ # Optional. Frequently asked questions and answers about the product. + { # A question and answer about the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProduct": [ # Optional. Products related to this product, such as accessories or substitutes. + { # A product related to this product. + "identifier": "A String", # Required. The identifier of the related product. + "identifierType": "A String", # Required. The identifier type of the related product, such as "GTIN" or "ID". + "relationshipType": "A String", # Required. The relationship to the related product, such as "ACCESSORY", "PART_OF_SET", "REQUIRED_PART", "OFTEN_BOUGHT_WITH", "SUBSTITUTE", or "DIFFERENT_BRAND". + }, + ], "releaseDate": "A String", # The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release. "richProductContent": [ # Rich product content. For more information, see https://support.google.com/manufacturers/answer/9389865 "A String", @@ -374,6 +394,12 @@

Method Details

"targetClientId": "A String", # The target client id. Should only be used in the accounts of the data partners. For more information, see https://support.google.com/manufacturers/answer/10857344 "theme": "A String", # The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme. "title": "A String", # The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title. + "variantOption": [ # Optional. The list of all variant-identifying options for the product. + { # A variant-identifying option for the product. + "name": "A String", # Required. The name of the variant option, such as "Color" or "Watch band style". + "value": "A String", # Required. The value of the variant option, such as "Red" or "Milanese loop". + }, + ], "videoLink": [ # The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video. "A String", ], @@ -462,6 +488,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the (English if >1 language) certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -476,6 +504,9 @@

Method Details

}, "description": "A String", # The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description. "disclosureDate": "A String", # The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure. + "documentLink": [ # Optional. URLs of PDF documents for the product, such as user manuals or specifications. + "A String", + ], "excludedDestination": [ # A list of excluded destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], @@ -523,6 +554,7 @@

Method Details

"A String", ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. + "itemGroupTitle": "A String", # Optional. The shared title of the product group that this variant belongs to. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. @@ -646,6 +678,7 @@

Method Details

], }, "pattern": "A String", # The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern. + "popularityRank": 3.14, # Optional. The popularity rank of the product from 0.0 (lowest) to 100.0 (highest). "productDetail": [ # The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. { # A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. "attributeName": "A String", # The name of the attribute. @@ -662,6 +695,19 @@

Method Details

"productType": [ # The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype. "A String", ], + "questionAndAnswer": [ # Optional. Frequently asked questions and answers about the product. + { # A question and answer about the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProduct": [ # Optional. Products related to this product, such as accessories or substitutes. + { # A product related to this product. + "identifier": "A String", # Required. The identifier of the related product. + "identifierType": "A String", # Required. The identifier type of the related product, such as "GTIN" or "ID". + "relationshipType": "A String", # Required. The relationship to the related product, such as "ACCESSORY", "PART_OF_SET", "REQUIRED_PART", "OFTEN_BOUGHT_WITH", "SUBSTITUTE", or "DIFFERENT_BRAND". + }, + ], "releaseDate": "A String", # The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release. "richProductContent": [ # Rich product content. For more information, see https://support.google.com/manufacturers/answer/9389865 "A String", @@ -679,6 +725,12 @@

Method Details

"targetClientId": "A String", # The target client id. Should only be used in the accounts of the data partners. For more information, see https://support.google.com/manufacturers/answer/10857344 "theme": "A String", # The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme. "title": "A String", # The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title. + "variantOption": [ # Optional. The list of all variant-identifying options for the product. + { # A variant-identifying option for the product. + "name": "A String", # Required. The name of the variant option, such as "Color" or "Watch band style". + "value": "A String", # Required. The value of the variant option, such as "Red" or "Milanese loop". + }, + ], "videoLink": [ # The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video. "A String", ], @@ -767,6 +819,8 @@

Method Details

{ # Description of a certification. "authority": "A String", # Required. Name of the certification body. "code": "A String", # Optional. A unique code to identify the certification. + "documentLink": "A String", # Optional. A URL to the (English if >1 language) certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf + "labelLink": "A String", # Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf "link": "A String", # Optional. A URL link to the certification. "logo": "A String", # Optional. A URL link to the certification logo. "name": "A String", # Required. Name of the certification. @@ -781,6 +835,9 @@

Method Details

}, "description": "A String", # The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description. "disclosureDate": "A String", # The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure. + "documentLink": [ # Optional. URLs of PDF documents for the product, such as user manuals or specifications. + "A String", + ], "excludedDestination": [ # A list of excluded destinations such as "ClientExport", "ClientShoppingCatalog" or "PartnerShoppingCatalog". For more information, see https://support.google.com/manufacturers/answer/7443550 "A String", ], @@ -828,6 +885,7 @@

Method Details

"A String", ], "itemGroupId": "A String", # The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid. + "itemGroupTitle": "A String", # Optional. The shared title of the product group that this variant belongs to. "material": "A String", # The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material. "mpn": "A String", # The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn. "nutrition": { # Nutrition Attributes. See more at https://support.google.com/manufacturers/answer/12098458#food-servings. @@ -951,6 +1009,7 @@

Method Details

], }, "pattern": "A String", # The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern. + "popularityRank": 3.14, # Optional. The popularity rank of the product from 0.0 (lowest) to 100.0 (highest). "productDetail": [ # The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. { # A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail. "attributeName": "A String", # The name of the attribute. @@ -967,6 +1026,19 @@

Method Details

"productType": [ # The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype. "A String", ], + "questionAndAnswer": [ # Optional. Frequently asked questions and answers about the product. + { # A question and answer about the product. + "answer": "A String", # Required. The answer text. + "question": "A String", # Required. The question text. + }, + ], + "relatedProduct": [ # Optional. Products related to this product, such as accessories or substitutes. + { # A product related to this product. + "identifier": "A String", # Required. The identifier of the related product. + "identifierType": "A String", # Required. The identifier type of the related product, such as "GTIN" or "ID". + "relationshipType": "A String", # Required. The relationship to the related product, such as "ACCESSORY", "PART_OF_SET", "REQUIRED_PART", "OFTEN_BOUGHT_WITH", "SUBSTITUTE", or "DIFFERENT_BRAND". + }, + ], "releaseDate": "A String", # The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release. "richProductContent": [ # Rich product content. For more information, see https://support.google.com/manufacturers/answer/9389865 "A String", @@ -984,6 +1056,12 @@

Method Details

"targetClientId": "A String", # The target client id. Should only be used in the accounts of the data partners. For more information, see https://support.google.com/manufacturers/answer/10857344 "theme": "A String", # The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme. "title": "A String", # The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title. + "variantOption": [ # Optional. The list of all variant-identifying options for the product. + { # A variant-identifying option for the product. + "name": "A String", # Required. The name of the variant option, such as "Color" or "Watch band style". + "value": "A String", # Required. The value of the variant option, such as "Red" or "Milanese loop". + }, + ], "videoLink": [ # The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video. "A String", ], diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.autofeedSettings.html b/docs/dyn/merchantapi_accounts_v1.accounts.autofeedSettings.html index d99c59f33a..ddab0cc023 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.autofeedSettings.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.autofeedSettings.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. + { # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. For more information, see [Configure Autofeed settings](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources#autofeed-settings). "eligible": True or False, # Output only. Determines whether the business is eligible for being enrolled into an autofeed. "enableProducts": True or False, # Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear. "name": "A String", # Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`. @@ -119,7 +119,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. +{ # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. For more information, see [Configure Autofeed settings](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources#autofeed-settings). "eligible": True or False, # Output only. Determines whether the business is eligible for being enrolled into an autofeed. "enableProducts": True or False, # Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear. "name": "A String", # Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`. @@ -134,7 +134,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. + { # Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. For more information, see [Configure Autofeed settings](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources#autofeed-settings). "eligible": True or False, # Output only. Determines whether the business is eligible for being enrolled into an autofeed. "enableProducts": True or False, # Required. Enables or disables product crawling through the autofeed for the given account. Autofeed accounts must meet [certain conditions](https://support.google.com/merchants/answer/7538732#Configure_automated_feeds_Standard_Experience), which can be checked through the `eligible` field. The account must **not** be a marketplace. When the autofeed is enabled for the first time, the products usually appear instantly. When re-enabling, it might take up to 24 hours for products to appear. "name": "A String", # Identifier. The resource name of the autofeed settings. Format: `accounts/{account}/autofeedSettings`. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.automaticImprovements.html b/docs/dyn/merchantapi_accounts_v1.accounts.automaticImprovements.html index 22fd4a8896..1ddaf78869 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.automaticImprovements.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.automaticImprovements.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account. + { # Collection of information related to the [automatic improvements](https://support.google.com/merchants/answer/12157888) of an account. For more information, see [Enable automatic improvements](https://developers.google.com/merchant/api/guides/automatic-improvements/overview). "imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask. "accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator. "allowAutomaticImageImprovements": True or False, # Enables automatic image improvements. @@ -138,7 +138,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account. +{ # Collection of information related to the [automatic improvements](https://support.google.com/merchants/answer/12157888) of an account. For more information, see [Enable automatic improvements](https://developers.google.com/merchant/api/guides/automatic-improvements/overview). "imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask. "accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator. "allowAutomaticImageImprovements": True or False, # Enables automatic image improvements. @@ -172,7 +172,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account. + { # Collection of information related to the [automatic improvements](https://support.google.com/merchants/answer/12157888) of an account. For more information, see [Enable automatic improvements](https://developers.google.com/merchant/api/guides/automatic-improvements/overview). "imageImprovements": { # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) # This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided in the update mask. "accountImageImprovementsSettings": { # Settings for the Automatic Image Improvements. # Optional. Determines how the images should be automatically updated. If this field is not present and provided in the update mask, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator. "allowAutomaticImageImprovements": True or False, # Enables automatic image improvements. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.businessIdentity.html b/docs/dyn/merchantapi_accounts_v1.accounts.businessIdentity.html index 17c93e408b..8db10af201 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.businessIdentity.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.businessIdentity.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). + { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). For more information, see [Manage business identity](https://developers.google.com/merchant/api/guides/accounts/business-identity). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, @@ -133,7 +133,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). +{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). For more information, see [Manage business identity](https://developers.google.com/merchant/api/guides/accounts/business-identity). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). + { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). For more information, see [Manage business identity](https://developers.google.com/merchant/api/guides/accounts/business-identity). "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for businesses with the business country set to `US`. It is also not applicable for marketplaces or marketplace sellers. "identityDeclaration": "A String", # Required. The declaration of identity for this attribute. }, diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1.accounts.businessInfo.html index c1221cee64..b4935b4335 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.businessInfo.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.businessInfo.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. + { # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. For more information, see [Add your business information](https://support.google.com/merchants/answer/14286818#add_bus_info) and [Update your business information](https://developers.google.com/merchant/api/guides/accounts/create-accounts#update_your_business_information). "address": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. The address of the business. Only `region_code`, `address_lines`, `postal_code`, `administrative_area` and `locality` fields are supported. All other fields are ignored. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", @@ -156,7 +156,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. +{ # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. For more information, see [Add your business information](https://support.google.com/merchants/answer/14286818#add_bus_info) and [Update your business information](https://developers.google.com/merchant/api/guides/accounts/create-accounts#update_your_business_information). "address": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. The address of the business. Only `region_code`, `address_lines`, `postal_code`, `administrative_area` and `locality` fields are supported. All other fields are ignored. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", @@ -208,7 +208,7 @@

Method Details

Returns: An object of the form: - { # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. + { # The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. For more information, see [Add your business information](https://support.google.com/merchants/answer/14286818#add_bus_info) and [Update your business information](https://developers.google.com/merchant/api/guides/accounts/create-accounts#update_your_business_information). "address": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. The address of the business. Only `region_code`, `address_lines`, `postal_code`, `administrative_area` and `locality` fields are supported. All other fields are ignored. "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas). "A String", diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html index a8656c802f..7d00f04c5e 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.developerRegistration.html @@ -79,16 +79,16 @@

Instance Methods

Close httplib2 connections.

getAccountForGcpRegistration(x__xgafv=None)

-

Retrieves the merchant account that the calling GCP is registered with.

+

Retrieves the merchant account that the calling GCP is registered with. For more information, see [Verify your account's connection to Merchant API](https://developers.google.com/merchant/api/guides/accounts/verify-api-access).

getDeveloperRegistration(name, x__xgafv=None)

Retrieves a developer registration for a merchant.

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

-

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.

+

Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration. For step-by-step instructions, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration).

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

-

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.

+

Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister successful call. For more information, see [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects).

Method Details

close() @@ -97,7 +97,7 @@

Method Details

getAccountForGcpRegistration(x__xgafv=None) -
Retrieves the merchant account that the calling GCP is registered with.
+  
Retrieves the merchant account that the calling GCP is registered with. For more information, see [Verify your account's connection to Merchant API](https://developers.google.com/merchant/api/guides/accounts/verify-api-access).
 
 Args:
   x__xgafv: string, V1 error format.
@@ -127,7 +127,7 @@ 

Method Details

Returns: An object of the form: - { # Represents a developer registration owned by a Merchant account. + { # Represents a developer registration owned by a Merchant account. For more information, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration) and [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects). "gcpIds": [ # Output only. The GCP ids attached to this developer registration "A String", ], @@ -137,10 +137,10 @@

Method Details

registerGcp(name, body=None, x__xgafv=None) -
Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.
+  
Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an "API developer" and add the "developer_email" as a contact with "API notifications" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration. For step-by-step instructions, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration).
 
 Args:
-  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. (required)
+  name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts)) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -156,7 +156,7 @@ 

Method Details

Returns: An object of the form: - { # Represents a developer registration owned by a Merchant account. + { # Represents a developer registration owned by a Merchant account. For more information, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration) and [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects). "gcpIds": [ # Output only. The GCP ids attached to this developer registration "A String", ], @@ -166,7 +166,7 @@

Method Details

unregisterGcp(name, body=None, x__xgafv=None) -
Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.
+  
Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister successful call. For more information, see [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects).
 
 Args:
   name: string, Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` (required)
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.emailPreferences.html b/docs/dyn/merchantapi_accounts_v1.accounts.emailPreferences.html
index f85084681a..2190789b33 100644
--- a/docs/dyn/merchantapi_accounts_v1.accounts.emailPreferences.html
+++ b/docs/dyn/merchantapi_accounts_v1.accounts.emailPreferences.html
@@ -103,7 +103,7 @@ 

Method Details

Returns: An object of the form: - { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. + { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. For more information, see [Change your Merchant Center email preferences](https://support.google.com/merchants/answer/9370919) and [Manage Merchant Center email preferences](https://developers.google.com/merchant/api/guides/accounts/email-notifications). "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices. }
@@ -118,7 +118,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. +{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. For more information, see [Change your Merchant Center email preferences](https://support.google.com/merchants/answer/9370919) and [Manage Merchant Center email preferences](https://developers.google.com/merchant/api/guides/accounts/email-notifications). "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices. } @@ -132,7 +132,7 @@

Method Details

Returns: An object of the form: - { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. + { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. For more information, see [Change your Merchant Center email preferences](https://support.google.com/merchants/answer/9370919) and [Manage Merchant Center email preferences](https://developers.google.com/merchant/api/guides/accounts/email-notifications). "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices. }
diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.gbpAccounts.html b/docs/dyn/merchantapi_accounts_v1.accounts.gbpAccounts.html index ed2abc10fd..40e037dc0b 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.gbpAccounts.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.gbpAccounts.html @@ -137,7 +137,7 @@

Method Details

{ # Response message for the ListGbpAccounts method. "gbpAccounts": [ # The GBP accounts from the specified merchant in the specified country. - { # Collection of information related to a Google Business Profile (GBP) account. + { # Collection of information related to a Google Business Profile (GBP) account. For more information, see [Link a Google business profile](https://developers.google.com/merchant/api/guides/accounts/link-business-profile). "gbpAccountId": "A String", # The id of the GBP account. "gbpAccountName": "A String", # The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account. "listingCount": "A String", # Number of listings under this account. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.homepage.html b/docs/dyn/merchantapi_accounts_v1.accounts.homepage.html index f9e1542780..74987298d4 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.homepage.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.homepage.html @@ -111,7 +111,7 @@

Method Details

Returns: An object of the form: - { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). + { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings). "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. @@ -137,7 +137,7 @@

Method Details

Returns: An object of the form: - { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). + { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings). "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. @@ -164,7 +164,7 @@

Method Details

Returns: An object of the form: - { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). + { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings). "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. @@ -180,7 +180,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). +{ # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings). "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. @@ -195,7 +195,7 @@

Method Details

Returns: An object of the form: - { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). + { # The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings). "claimed": True or False, # Output only. Whether the homepage is claimed. See [About online store URL verification](https://support.google.com/merchants/answer/176793). This field is also `true` if the account inherits the claim from its advanced account, or if the account is exempted from claiming, even when the homepage isn't claimed directly on the account. "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` "uri": "A String", # Required. The URI (typically a URL) of the store's homepage. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.html b/docs/dyn/merchantapi_accounts_v1.accounts.html index ca5f88faca..943005020f 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.html @@ -169,10 +169,10 @@

Instance Methods

Close httplib2 connections.

createAndConfigure(body=None, x__xgafv=None)

-

Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.

+

Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. For step-by-step instructions, see [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts).

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

-

Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.

+

Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic. For more information, see [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts).

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

Deletes the specified account regardless of its type: standalone, advanced account or sub-account. Deleting an advanced account leads to the deletion of all of its sub-accounts. This also deletes the account's [developer registration entity](/merchant/api/reference/rest/accounts_v1/accounts.developerRegistration) and any associated GCP project to the account. Executing this method requires admin access. The deletion succeeds only if the account does not provide services to any other account and has no processed offers. You can use the `force` parameter to override this.

@@ -181,7 +181,7 @@

Instance Methods

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

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

-

Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.

+

Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. For more information, see [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter).

listSubaccounts(provider, pageSize=None, pageToken=None, x__xgafv=None)

List all sub-accounts for a given advanced account. This is a convenience wrapper for the more powerful `accounts.list` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))`

@@ -202,14 +202,14 @@

Method Details

createAndConfigure(body=None, x__xgafv=None) -
Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.
+  
Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. For step-by-step instructions, see [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts).
 
 Args:
   body: object, The request body.
     The object takes the form of:
 
 { # Request message for the `CreateAndConfigureAccount` method.
-  "account": { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. # Required. The account to be created.
+  "account": { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). # Required. The account to be created.
     "accountId": "A String", # Output only. The ID of the account.
     "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information.
     "adultContent": True or False, # Optional. Whether this account contains adult content.
@@ -246,8 +246,8 @@ 

Method Details

], "user": [ # Optional. Users to be added to the account. { # Instruction for adding a user to the account during creation. - "user": { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). # Optional. Details about the user to be added. At the moment, only access rights may be specified. - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + "user": { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). # Optional. Details about the user to be added. At the moment, only access rights may be specified. + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -269,7 +269,7 @@

Method Details

Returns: An object of the form: - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -286,14 +286,14 @@

Method Details

createTestAccount(parent, body=None, x__xgafv=None) -
Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.
+  
Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic. For more information, see [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts).
 
 Args:
   parent: string, Required. The account resource name to create the test account under. Format: accounts/{account} (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.
+{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter).
   "accountId": "A String", # Output only. The ID of the account.
   "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information.
   "adultContent": True or False, # Optional. Whether this account contains adult content.
@@ -315,7 +315,7 @@ 

Method Details

Returns: An object of the form: - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -363,7 +363,7 @@

Method Details

Returns: An object of the form: - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -380,7 +380,7 @@

Method Details

list(filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.
+  
Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. For more information, see [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter).
 
 Args:
   filter: string, Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax).
@@ -396,7 +396,7 @@ 

Method Details

{ # Response message for the `accounts.list` method. "accounts": [ # The accounts matching the `ListAccountsRequest`. - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -432,7 +432,7 @@

Method Details

{ # Response message for the `ListSubAccounts` method. "accounts": [ # The accounts for which the given parent account is an aggregator. - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -487,7 +487,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. +{ # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. @@ -510,7 +510,7 @@

Method Details

Returns: An object of the form: - { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. + { # The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter). "accountId": "A String", # Output only. The ID of the account. "accountName": "A String", # Required. A human-readable name of the account. Don't use punctuation, capitalization, or non-alphanumeric symbols such as the "/" or "_" symbols. See [Adding a business name](https://support.google.com/merchants/answer/12159159) for more information. "adultContent": True or False, # Optional. Whether this account contains adult content. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.issues.html b/docs/dyn/merchantapi_accounts_v1.accounts.issues.html index 77e4fcf6ee..9b216edb09 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.issues.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.issues.html @@ -109,7 +109,7 @@

Method Details

{ # Response message for the `ListAccountIssues` method. "accountIssues": [ # The issues from the specified account. - { # Issues with your Merchant Center account that can impact all your products. For more information, see [Account-level issues in Merchant Center](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account). + { # Issues with your Merchant Center account that can impact all your products. For more information, see [Account-level issues in Merchant Center](https://support.google.com/merchants/answer/12153802#account) and [View account issues](https://developers.google.com/merchant/api/guides/accounts/view-issues). "detail": "A String", # Further localized details about the issue. "documentationUri": "A String", # Link to Merchant Center Help Center providing further information about the issue and how to fix it. "impactedDestinations": [ # The impact this issue has on various destinations. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.html b/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.html index 4544c3a697..4866adb5c7 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.html @@ -115,7 +115,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Collection of information related to the omnichannel settings of a merchant. +{ # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -156,7 +156,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the omnichannel settings of a merchant. + { # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -204,7 +204,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the omnichannel settings of a merchant. + { # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -257,7 +257,7 @@

Method Details

{ # Response message for the ListOmnichannelSettings method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "omnichannelSettings": [ # The omnichannel settings from the specified merchant. - { # Collection of information related to the omnichannel settings of a merchant. + { # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -316,7 +316,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Collection of information related to the omnichannel settings of a merchant. +{ # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -358,7 +358,7 @@

Method Details

Returns: An object of the form: - { # Collection of information related to the omnichannel settings of a merchant. + { # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. @@ -413,7 +413,7 @@

Method Details

An object of the form: { # Response message for the RequestInventoryVerification method. - "omnichannelSetting": { # Collection of information related to the omnichannel settings of a merchant. # The omnichannel setting that was updated. + "omnichannelSetting": { # Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings). # The omnichannel setting that was updated. "about": { # Collection of information related to the about page ([impressum](https://support.google.com/merchants/answer/14675634?ref_topic=15145634&sjid=6892280366904591178-NC)). # Optional. The about page URI and state for this country. "state": "A String", # Output only. The state of the URI. "uri": "A String", # Required. The about page URI. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.lfpProviders.html b/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.lfpProviders.html index 29f2b9f924..1b1a7964e2 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.lfpProviders.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.omnichannelSettings.lfpProviders.html @@ -110,7 +110,7 @@

Method Details

{ # Response message for the FindLfpProviders method. "lfpProviders": [ # The LFP providers from the specified merchant in the specified country. - { # Collection of information related to a Local Feed Partnership (LFP) provider. + { # Collection of information related to a Local Feed Partnership (LFP) provider. For more information, see [Manage Local Feeds Partnership (LFP) providers](https://developers.google.com/merchant/api/guides/accounts/manage-lfp-providers) and [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "displayName": "A String", # The display name of the LFP provider. "name": "A String", # Identifier. The resource name of the LFP provider. Format: `accounts/{account}/omnichannelSettings/{omnichannel_setting}/lfpProviders/{lfp_provider}` "regionCode": "A String", # Output only. Region code defined by [CLDR](https://cldr.unicode.org/). diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.onlineReturnPolicies.html b/docs/dyn/merchantapi_accounts_v1.accounts.onlineReturnPolicies.html index f2f9952a9b..2795d0cef6 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.onlineReturnPolicies.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.onlineReturnPolicies.html @@ -107,7 +107,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. +{ # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. For more information, see [Manage your online return policies](https://developers.google.com/merchant/api/guides/online-return-policies/overview). "acceptDefectiveOnly": True or False, # Optional. This field specifies if business only accepts defective products for returns. "acceptExchange": True or False, # Optional. This field specifies if business allows customers to exchange products. "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. @@ -174,7 +174,7 @@

Method Details

Returns: An object of the form: - { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. + { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. For more information, see [Manage your online return policies](https://developers.google.com/merchant/api/guides/online-return-policies/overview). "acceptDefectiveOnly": True or False, # Optional. This field specifies if business only accepts defective products for returns. "acceptExchange": True or False, # Optional. This field specifies if business allows customers to exchange products. "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. @@ -266,7 +266,7 @@

Method Details

Returns: An object of the form: - { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. + { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. For more information, see [Manage your online return policies](https://developers.google.com/merchant/api/guides/online-return-policies/overview). "acceptDefectiveOnly": True or False, # Optional. This field specifies if business only accepts defective products for returns. "acceptExchange": True or False, # Optional. This field specifies if business allows customers to exchange products. "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. @@ -345,7 +345,7 @@

Method Details

{ # Response message for the `ListOnlineReturnPolicies` method. "nextPageToken": "A String", # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. "onlineReturnPolicies": [ # The retrieved return policies. - { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. + { # [Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. For more information, see [Manage your online return policies](https://developers.google.com/merchant/api/guides/online-return-policies/overview). "acceptDefectiveOnly": True or False, # Optional. This field specifies if business only accepts defective products for returns. "acceptExchange": True or False, # Optional. This field specifies if business allows customers to exchange products. "countries": [ # Required. Immutable. The countries of sale where the return policy applies. The values must be a valid 2 letter ISO 3166 code. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.programs.checkoutSettings.html b/docs/dyn/merchantapi_accounts_v1.accounts.programs.checkoutSettings.html index e726ffa98a..0bbbcd5fb7 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.programs.checkoutSettings.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.programs.checkoutSettings.html @@ -104,7 +104,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. +{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings). "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveReviewState": "A String", # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveUriSettings": { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). @@ -131,7 +131,7 @@

Method Details

Returns: An object of the form: - { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. + { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings). "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveReviewState": "A String", # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveUriSettings": { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). @@ -183,7 +183,7 @@

Method Details

Returns: An object of the form: - { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. + { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings). "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveReviewState": "A String", # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveUriSettings": { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). @@ -212,7 +212,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. +{ # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings). "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveReviewState": "A String", # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveUriSettings": { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). @@ -240,7 +240,7 @@

Method Details

Returns: An object of the form: - { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. + { # [CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings). "effectiveEnrollmentState": "A String", # Output only. The effective value of enrollment_state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveReviewState": "A String", # Output only. The effective value of `review_state` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). "effectiveUriSettings": { # URL settings for cart or checkout URL. # Output only. The effective value of `uri_settings` for a given merchant. If account level settings are present then this value will be a copy of url settings. Otherwise, it will have the value of the parent account (for only marketplace sellers). diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html index f4d750d27a..a26a2530c1 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`](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` + { # 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. For more information, see [Manage programs](https://developers.google.com/merchant/api/guides/programs/overview). 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`](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` + { # 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. For more information, see [Manage programs](https://developers.google.com/merchant/api/guides/programs/overview). 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`](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` + { # 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. For more information, see [Manage programs](https://developers.google.com/merchant/api/guides/programs/overview). 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`](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` + { # 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. For more information, see [Manage programs](https://developers.google.com/merchant/api/guides/programs/overview). 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_v1.accounts.regions.html b/docs/dyn/merchantapi_accounts_v1.accounts.regions.html index 301e041deb..2a319f6478 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.regions.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.regions.html @@ -76,13 +76,13 @@

Merchant API . batchCreate(parent, body=None, x__xgafv=None)

-

Creates one or more regions in your Merchant Center account. Executing this method requires admin access.

+

Creates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).

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

-

Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access.

+

Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).

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

-

Updates one or more regions in your Merchant Center account. Executing this method requires admin access.

+

Updates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).

close()

Close httplib2 connections.

@@ -107,7 +107,7 @@

Instance Methods

Method Details

batchCreate(parent, body=None, x__xgafv=None) -
Creates one or more regions in your Merchant Center account. Executing this method requires admin access.
+  
Creates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).
 
 Args:
   parent: string, Required. The account to create one or more regions for. Format: `accounts/{account}` (required)
@@ -118,7 +118,7 @@ 

Method Details

"requests": [ # Required. The region(s) to create. The maximum number of regions that can be created in a batch is 100. { # Request message for the `CreateRegion` method. "parent": "A String", # Required. The account to create a region for. Format: `accounts/{account}` - "region": { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. # Required. The region to create. + "region": { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). # Required. The region to create. "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -162,7 +162,7 @@

Method Details

{ # Response message for the `BatchCreateRegions` method. "regions": [ # The created region(s). - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -197,7 +197,7 @@

Method Details

batchDelete(parent, body=None, x__xgafv=None) -
Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access.
+  
Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).
 
 Args:
   parent: string, Required. The account to delete one or more regions from. Format: `accounts/{account}` (required)
@@ -226,7 +226,7 @@ 

Method Details

batchUpdate(parent, body=None, x__xgafv=None) -
Updates one or more regions in your Merchant Center account. Executing this method requires admin access.
+  
Updates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).
 
 Args:
   parent: string, Required. The account to update one or more regions for. Format: `accounts/{account}` (required)
@@ -236,7 +236,7 @@ 

Method Details

{ # Request message for the `BatchUpdateRegions` method. "requests": [ # Required. The region(s) to update. The maximum number of regions that can be updated in a batch is 100. { # Request message for the `UpdateRegion` method. - "region": { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. # Required. The updated region. + "region": { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). # Required. The updated region. "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -280,7 +280,7 @@

Method Details

{ # Response message for the `BatchUpdateRegions` method. "regions": [ # The updated region(s). - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -327,7 +327,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. +{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -366,7 +366,7 @@

Method Details

Returns: An object of the form: - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -429,7 +429,7 @@

Method Details

Returns: An object of the form: - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -479,7 +479,7 @@

Method Details

{ # Response message for the `ListRegions` method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "regions": [ # The regions from the specified business. - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -535,7 +535,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. +{ # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). @@ -574,7 +574,7 @@

Method Details

Returns: An object of the form: - { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information. + { # Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching). "displayName": "A String", # Optional. The display name of the region. "geotargetArea": { # A list of geotargets that defines the region area. # Optional. A list of geotargets that defines the region area. "geotargetCriteriaIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (for example, state). diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.relationships.html b/docs/dyn/merchantapi_accounts_v1.accounts.relationships.html index 161523b0e4..43c0103778 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.relationships.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.relationships.html @@ -109,7 +109,7 @@

Method Details

Returns: An object of the form: - { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). + { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships). "accountIdAlias": "A String", # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. "name": "A String", # Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`. "provider": "A String", # Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). @@ -135,7 +135,7 @@

Method Details

{ # Response after trying to list account relationships. "accountRelationships": [ # The account relationships that match your filter. - { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). + { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships). "accountIdAlias": "A String", # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. "name": "A String", # Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`. "provider": "A String", # Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). @@ -169,7 +169,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). +{ # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships). "accountIdAlias": "A String", # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. "name": "A String", # Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`. "provider": "A String", # Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). @@ -185,7 +185,7 @@

Method Details

Returns: An object of the form: - { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). + { # The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships). "accountIdAlias": "A String", # Optional. An optional alias you can assign to this account relationship. This alias acts as a convenient identifier for your own reference and management. It must be unique among all your account relationships with the same provider. For example, you might use `account_id_alias` to assign a friendly name to this relationship for easier identification in your systems. "name": "A String", # Identifier. The resource name of the account relationship. Format: `accounts/{account}/relationships/{relationship}`. For example, `accounts/123456/relationships/567890`. "provider": "A String", # Immutable. The provider of the service. Either the reference to an account such as `providers/123` or a well-known service provider (one of `providers/GOOGLE_ADS` or `providers/GOOGLE_BUSINESS_PROFILE`). diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.services.html b/docs/dyn/merchantapi_accounts_v1.accounts.services.html index fbabba6973..e604714049 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.services.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.services.html @@ -116,7 +116,7 @@

Method Details

Returns: An object of the form: - { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. + { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes). "accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is a multi-client advanced account, to manage multiple sub-accounts (client accounts). Through this service, the service provider can perform administrative and operational tasks across all linked sub-accounts. This is used by store builders (ecommerce platforms), channel partners, marketplaces, multi-brand retailers, and international retailers that need centralized control over sub-accounts in Merchant Center. }, "accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information. @@ -160,7 +160,7 @@

Method Details

Returns: An object of the form: - { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. + { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes). "accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is a multi-client advanced account, to manage multiple sub-accounts (client accounts). Through this service, the service provider can perform administrative and operational tasks across all linked sub-accounts. This is used by store builders (ecommerce platforms), channel partners, marketplaces, multi-brand retailers, and international retailers that need centralized control over sub-accounts in Merchant Center. }, "accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information. @@ -203,7 +203,7 @@

Method Details

{ # Response after trying to list account services. "accountServices": [ # The account services that match your filter. - { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. + { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes). "accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is a multi-client advanced account, to manage multiple sub-accounts (client accounts). Through this service, the service provider can perform administrative and operational tasks across all linked sub-accounts. This is used by store builders (ecommerce platforms), channel partners, marketplaces, multi-brand retailers, and international retailers that need centralized control over sub-accounts in Merchant Center. }, "accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information. @@ -255,7 +255,7 @@

Method Details

The object takes the form of: { # Request to propose an account service. - "accountService": { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. # Required. The account service to propose. + "accountService": { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes). # Required. The account service to propose. "accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is a multi-client advanced account, to manage multiple sub-accounts (client accounts). Through this service, the service provider can perform administrative and operational tasks across all linked sub-accounts. This is used by store builders (ecommerce platforms), channel partners, marketplaces, multi-brand retailers, and international retailers that need centralized control over sub-accounts in Merchant Center. }, "accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information. @@ -289,7 +289,7 @@

Method Details

Returns: An object of the form: - { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. + { # The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes). "accountAggregation": { # `AccountAggregation` payload. # Service type for account aggregation. This enables the provider, which is a multi-client advanced account, to manage multiple sub-accounts (client accounts). Through this service, the service provider can perform administrative and operational tasks across all linked sub-accounts. This is used by store builders (ecommerce platforms), channel partners, marketplaces, multi-brand retailers, and international retailers that need centralized control over sub-accounts in Merchant Center. }, "accountManagement": { # `AccountManagement` payload. # Service type for account management. Enables the provider to perform administrative actions on the business's account, such as configuring account settings, managing users, or updating business information. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.shippingSettings.html b/docs/dyn/merchantapi_accounts_v1.accounts.shippingSettings.html index c4b4dd233d..00e4fd6880 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.shippingSettings.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.shippingSettings.html @@ -103,7 +103,7 @@

Method Details

Returns: An object of the form: - { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. + { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. For more information, see [Manage shipping settings](https://developers.google.com/merchant/api/guides/accounts/manage-shipping-settings). "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. @@ -421,7 +421,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. +{ # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. For more information, see [Manage shipping settings](https://developers.google.com/merchant/api/guides/accounts/manage-shipping-settings). "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. @@ -737,7 +737,7 @@

Method Details

Returns: An object of the form: - { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. + { # The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. For more information, see [Manage shipping settings](https://developers.google.com/merchant/api/guides/accounts/manage-shipping-settings). "etag": "A String", # Required. This field helps avoid async issues. It ensures that the shipping setting data doesn't change between the `get` call and the `insert` call. The user should follow these steps: 1. Set the etag field as an empty string for the initial shipping setting creation. 2. After the initial creation, call the `get` method to obtain an etag and the current shipping setting data before calling `insert`. 3. Modify the shipping setting information. 4. Call the `insert` method with the shipping setting information and the etag obtained in step 2. 5. If the shipping setting data changes between step 2 and step 4, the insert request will fail because the etag changes every time the shipping setting data changes. In this case, the user should repeat steps 2-4 with the new etag. "name": "A String", # Identifier. The resource name of the shipping settings. Format: `accounts/{account}/shippingSettings`. For example, `accounts/123456/shippingSettings`. "services": [ # Optional. The target account's list of services. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.termsOfServiceAgreementStates.html b/docs/dyn/merchantapi_accounts_v1.accounts.termsOfServiceAgreementStates.html index 31eb0d5257..314cd6f538 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.termsOfServiceAgreementStates.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.termsOfServiceAgreementStates.html @@ -103,8 +103,8 @@

Method Details

Returns: An object of the form: - { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. - "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. For more information, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements). + "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements#accept-tos). # Optional. The accepted terms of service of this kind and for the associated region_code "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. "termsOfService": "A String", # Required. The accepted termsOfService. "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. @@ -137,8 +137,8 @@

Method Details

Returns: An object of the form: - { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. - "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. For more information, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements). + "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements#accept-tos). # Optional. The accepted terms of service of this kind and for the associated region_code "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. "termsOfService": "A String", # Required. The accepted termsOfService. "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.users.html b/docs/dyn/merchantapi_accounts_v1.accounts.users.html index c89a80d370..6a2232a1e8 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.users.html @@ -115,8 +115,8 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. +{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -132,8 +132,8 @@

Method Details

Returns: An object of the form: - { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -173,8 +173,8 @@

Method Details

Returns: An object of the form: - { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -201,8 +201,8 @@

Method Details

{ # Response message for the `ListUsers` method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "users": [ # The users from the specified account. - { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -235,8 +235,8 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. +{ # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. @@ -252,8 +252,8 @@

Method Details

Returns: An object of the form: - { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.users.me.html b/docs/dyn/merchantapi_accounts_v1.accounts.users.me.html index acb1ba32e5..d18f2e4e72 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.users.me.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.users.me.html @@ -106,8 +106,8 @@

Method Details

Returns: An object of the form: - { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472). - "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. + { # The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access). + "accessRights": [ # Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has. "A String", ], "name": "A String", # Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. diff --git a/docs/dyn/merchantapi_accounts_v1.termsOfService.html b/docs/dyn/merchantapi_accounts_v1.termsOfService.html index 94978790cf..834081c6f4 100644 --- a/docs/dyn/merchantapi_accounts_v1.termsOfService.html +++ b/docs/dyn/merchantapi_accounts_v1.termsOfService.html @@ -104,8 +104,8 @@

Method Details

An object of the form: { # Response message for the `AcceptTermsOfService` method. - "termsOfServiceAgreementState": { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. # The agreement state after accepting the ToS. - "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service). # Optional. The accepted terms of service of this kind and for the associated region_code + "termsOfServiceAgreementState": { # This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. For more information, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements). # The agreement state after accepting the ToS. + "accepted": { # Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements#accept-tos). # Optional. The accepted terms of service of this kind and for the associated region_code "acceptedBy": "A String", # Required. The account where the acceptance was recorded. This can be the account itself or, in the case of subaccounts, the advanced account. "termsOfService": "A String", # Required. The accepted termsOfService. "validUntil": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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. When set, it states that the accepted `TermsOfService` is only valid until the end of this date (in UTC). A new one must be accepted before then. The information of the required `TermsOfService` is found in the `Required` message. @@ -144,7 +144,7 @@

Method Details

Returns: An object of the form: - { # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. + { # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. For step-by-step instructions, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements). "external": True or False, # Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API. "fileUri": "A String", # URI for terms of service file that needs to be displayed to signing users. "kind": "A String", # The Kind this terms of service version applies to. @@ -171,7 +171,7 @@

Method Details

Returns: An object of the form: - { # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. + { # The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. For step-by-step instructions, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements). "external": True or False, # Whether this terms of service version is external. External terms of service versions can only be agreed through external processes and not directly by the merchant through UI or API. "fileUri": "A String", # URI for terms of service file that needs to be displayed to signing users. "kind": "A String", # The Kind this terms of service version applies to. diff --git a/docs/dyn/merchantapi_conversions_v1.accounts.conversionSources.html b/docs/dyn/merchantapi_conversions_v1.accounts.conversionSources.html index 4124a8de55..d8893df54f 100644 --- a/docs/dyn/merchantapi_conversions_v1.accounts.conversionSources.html +++ b/docs/dyn/merchantapi_conversions_v1.accounts.conversionSources.html @@ -113,7 +113,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. +{ # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -157,7 +157,7 @@

Method Details

Returns: An object of the form: - { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. + { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -226,7 +226,7 @@

Method Details

Returns: An object of the form: - { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. + { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -282,7 +282,7 @@

Method Details

{ # Response message for the ListConversionSources method. "conversionSources": [ # List of conversion sources. - { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. + { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -345,7 +345,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. +{ # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -390,7 +390,7 @@

Method Details

Returns: An object of the form: - { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. + { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". @@ -447,7 +447,7 @@

Method Details

Returns: An object of the form: - { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. + { # Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview). "controller": "A String", # Output only. Controller of the conversion source. "expireTime": "A String", # Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete. "googleAnalyticsLink": { # "Google Analytics Link" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account. # Immutable. Conversion Source of type "Link to Google Analytics Property". diff --git a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.fileUploads.html b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.fileUploads.html index 96e3974270..26969a5b69 100644 --- a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.fileUploads.html +++ b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.fileUploads.html @@ -100,7 +100,7 @@

Method Details

Returns: An object of the form: - { # The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources. + { # The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources. For more information, see [Monitor and trigger data source processing](https://developers.google.com/merchant/api/guides/data-sources/monitor-status) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "issues": [ # Output only. The list of issues occurring in the data source. { # An error occurring in the data source, like "invalid price". diff --git a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html index d6b4f42e35..3d7f4103c8 100644 --- a/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html +++ b/docs/dyn/merchantapi_datasources_v1.accounts.dataSources.html @@ -84,13 +84,13 @@

Instance Methods

Close httplib2 connections.

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

-

Creates the new data source configuration for the given account. This method always creates a new data source.

+

Creates the new data source configuration for the given account. This method always creates a new data source. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).

delete(name, x__xgafv=None)

Deletes a data source from your Merchant Center account.

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

-

Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.

+

Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set. For more information, see [Monitor and trigger data source processing](https://developers.google.com/merchant/api/guides/data-sources/monitor-status).

get(name, x__xgafv=None)

Retrieves the data source configuration for the given account.

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates the new data source configuration for the given account. This method always creates a new data source.
+  
Creates the new data source configuration for the given account. This method always creates a new data source. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).
 
 Args:
   parent: string, Required. The account where this data source will be created. Format: `accounts/{account}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.
+{ # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).
   "dataSourceId": "A String", # Output only. The data source id.
   "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI.
   "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file.
@@ -150,7 +150,6 @@ 

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", @@ -204,7 +203,7 @@

Method Details

Returns: An object of the form: - { # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. + { # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI. "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file. @@ -236,7 +235,6 @@

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", @@ -303,7 +301,7 @@

Method Details

fetch(name, body=None, x__xgafv=None) -
Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.
+  
Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set. For more information, see [Monitor and trigger data source processing](https://developers.google.com/merchant/api/guides/data-sources/monitor-status).
 
 Args:
   name: string, Required. The name of the data source resource to fetch. Format: `accounts/{account}/dataSources/{datasource}` (required)
@@ -339,7 +337,7 @@ 

Method Details

Returns: An object of the form: - { # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. + { # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI. "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file. @@ -371,7 +369,6 @@

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", @@ -436,7 +433,7 @@

Method Details

{ # Response message for the ListDataSources method. "dataSources": [ # The data sources from the specified account. - { # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. + { # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI. "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file. @@ -468,7 +465,6 @@

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", @@ -541,7 +537,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. +{ # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI. "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file. @@ -573,7 +569,6 @@

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", @@ -628,7 +623,7 @@

Method Details

Returns: An object of the form: - { # The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account. + { # The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources). "dataSourceId": "A String", # Output only. The data source id. "displayName": "A String", # Required. The displayed data source name in the Merchant Center UI. "fileInput": { # The data specific for file data sources. This field is empty for other data source inputs. # Optional. The field is used only when data is managed through a file. @@ -660,7 +655,6 @@

Method Details

}, "name": "A String", # Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` "primaryProductDataSource": { # The primary data source for local and online products. # The [primary data source](https://support.google.com/merchants/answer/7439058) for local and online products. - "channel": "A String", # Optional. Immutable. Specifies the type of data source channel. "contentLanguage": "A String", # Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction. "countries": [ # Optional. The countries where the items may be displayed. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "A String", diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html index b45abada16..f019bead6b 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.localInventories.html @@ -82,7 +82,7 @@

Instance Methods

Deletes the specified `LocalInventory` from the given product in your merchant account. It might take a up to an hour for the `LocalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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

-

Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.

+

Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products. For step-by-step instructions, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory).

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

Lists the `LocalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `LocalInventory` resources are listed per product for a given account.

@@ -115,14 +115,14 @@

Method Details

insert(parent, body=None, x__xgafv=None) -
Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.
+  
Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products. For step-by-step instructions, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory).
 
 Args:
   parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).
+{ # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). For more information, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory).
   "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client.
   "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).
   "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes.
@@ -186,7 +186,7 @@ 

Method Details

Returns: An object of the form: - { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). + { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). For more information, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. @@ -261,7 +261,7 @@

Method Details

{ # Response message for the `ListLocalInventories` method. "localInventories": [ # The `LocalInventory` resources for the given product from the specified account. - { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). + { # Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). For more information, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `LocalInventory` resource. Format: `accounts/{account}/products/{product}/localInventories/{store_code}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for the decoded product ID `en~US~sku/123` and `store_code` "store123". Can be used directly as input to the API methods that require the local product identifier within the local inventory name to be encoded if it contains special characters, for example [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get). "localInventoryAttributes": { # Local inventory attributes. # Optional. A list of local inventory attributes. diff --git a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html index bbbbbbbdd1..968a32b0af 100644 --- a/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html +++ b/docs/dyn/merchantapi_inventories_v1.accounts.products.regionalInventories.html @@ -82,7 +82,7 @@

Instance Methods

Deletes the specified `RegionalInventory` resource from the given product in your merchant account. It might take up to an hour for the `RegionalInventory` to be deleted from the specific product. Once you have received a successful delete response, wait for that period before attempting a delete again.

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

-

Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.

+

Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products. For step-by-step instructions, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory) and [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory).

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

Lists the `RegionalInventory` resources for the given product in your merchant account. The response might contain fewer items than specified by `pageSize`. If `pageToken` was returned in previous request, it can be used to obtain additional results. `RegionalInventory` resources are listed per product for a given account.

@@ -115,14 +115,14 @@

Method Details

insert(parent, body=None, x__xgafv=None) -
Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.
+  
Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products. For step-by-step instructions, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory) and [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory).
 
 Args:
   parent: string, Required. The account and product where this inventory will be inserted. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an **unpadded base64url** encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880).
+{ # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). For more information, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory), [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory), and [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions).
   "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client.
   "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get).
   "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an **unpadded base64url** encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats.
@@ -172,7 +172,7 @@ 

Method Details

Returns: An object of the form: - { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). + { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). For more information, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory), [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory), and [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get). "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an **unpadded base64url** encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. @@ -234,7 +234,7 @@

Method Details

{ # Response message for the `ListRegionalInventories` method. "nextPageToken": "A String", # A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. "regionalInventories": [ # The `RegionalInventory` resources for the given product from the specified account. - { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). + { # Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). For more information, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory), [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory), and [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions). "account": "A String", # Output only. The account that owns the product. This field will be ignored if set by the client. "base64EncodedName": "A String", # Output only. The unpadded base64url encoded name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` where the `{product}` segment is the unpadded base64url encoded value of the identifier of the form `content_language~feed_label~offer_id`. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123` for the decoded product ID `en~US~sku/123` and `region` "region123". Can be used directly as input to the API methods that require the product identifier within the regional inventory name to be encoded if it contains special characters, for example [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get). "name": "A String", # Output only. The name of the `RegionalInventory` resource. Format: `accounts/{account}/products/{product}/regionalInventories/{region}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an **unpadded base64url** encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123` for `region` "region123", the `{product}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional inventory would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. diff --git a/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html b/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html index 3471594182..5450e60e10 100644 --- a/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html +++ b/docs/dyn/merchantapi_issueresolution_v1.accounts.aggregateProductStatuses.html @@ -108,7 +108,7 @@

Method Details

{ # Response message for the `ListAggregateProductStatuses` method. "aggregateProductStatuses": [ # The `AggregateProductStatuses` resources for the given account. - { # Aggregate product statuses for a given reporting context and country. + { # Aggregate product statuses for a given reporting context and country. For more information, see [View Aggregate Product Statuses](https://developers.google.com/merchant/api/guides/accounts/aggregate-product-statuses). "country": "A String", # The country of the aggregate product statuses. Represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). "itemLevelIssues": [ # The product issues that affect the given reporting context and country. { # The ItemLevelIssue of the product status. diff --git a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html index 34db7f7baa..4e40ec9646 100644 --- a/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html +++ b/docs/dyn/merchantapi_issueresolution_v1.issueresolution.html @@ -79,13 +79,13 @@

Instance Methods

Close httplib2 connections.

renderaccountissues(name, body=None, languageCode=None, timeZone=None, x__xgafv=None)

-

Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

+

Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).

renderproductissues(name, body=None, languageCode=None, timeZone=None, x__xgafv=None)

-

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.

+

Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).

triggeraction(name, body=None, languageCode=None, x__xgafv=None)

-

Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under "What is the issue/question?" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.

+

Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under "What is the issue/question?" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).

Method Details

close() @@ -94,7 +94,7 @@

Method Details

renderaccountissues(name, body=None, languageCode=None, timeZone=None, x__xgafv=None) -
Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
+  
Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).
 
 Args:
   name: string, Required. The account to fetch issues for. Format: `accounts/{account}` (required)
@@ -118,7 +118,7 @@ 

Method Details

{ # Response containing an issue resolution content and actions for listed account issues. "renderedIssues": [ # List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered. - { # An issue affecting specific business or their product. + { # An issue affecting specific business or their product. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues). "actions": [ # A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue. { # An actionable step that can be executed to solve the issue. "builtinSimpleAction": { # Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to business and will help them with resolving the issue. The application should point the business to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to the business and provide them with instructions how to solve the issue. # Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available. @@ -233,7 +233,7 @@

Method Details

renderproductissues(name, body=None, languageCode=None, timeZone=None, x__xgafv=None) -
Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.
+  
Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).
 
 Args:
   name: string, Required. The name of the product. Format: `accounts/{account}/products/{product}` The `{product}` segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the `{product}` segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{product}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{product}` segment must be the base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/products/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{product}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{product}` segment is used to differentiate between the two formats. (required)
@@ -257,7 +257,7 @@ 

Method Details

{ # Response containing an issue resolution content and actions for listed product issues. "renderedIssues": [ # List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered. - { # An issue affecting specific business or their product. + { # An issue affecting specific business or their product. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues). "actions": [ # A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when business disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to the business when they expand the issue. { # An actionable step that can be executed to solve the issue. "builtinSimpleAction": { # Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to business and will help them with resolving the issue. The application should point the business to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to the business and provide them with instructions how to solve the issue. # Action implemented and performed in (your) third-party application. The application should point the business to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available. @@ -372,7 +372,7 @@

Method Details

triggeraction(name, body=None, languageCode=None, x__xgafv=None) -
Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under "What is the issue/question?" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.
+  
Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under "What is the issue/question?" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).
 
 Args:
   name: string, Required. The business's account that is triggering the action. Format: `accounts/{account}` (required)
diff --git a/docs/dyn/merchantapi_lfp_v1.accounts.lfpInventories.html b/docs/dyn/merchantapi_lfp_v1.accounts.lfpInventories.html
index 71959382d2..41b406e700 100644
--- a/docs/dyn/merchantapi_lfp_v1.accounts.lfpInventories.html
+++ b/docs/dyn/merchantapi_lfp_v1.accounts.lfpInventories.html
@@ -95,11 +95,11 @@ 

Method Details

body: object, The request body. The object takes the form of: -{ # Local Inventory for the merchant. +{ # Local Inventory for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "availability": "A String", # Required. Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "collectionTime": "A String", # Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted. "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. - "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`. + "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`. "gtin": "A String", # Optional. The Global Trade Item Number of the product. "name": "A String", # Output only. Identifier. The name for the `LfpInventory` resource. Format: `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}` "offerId": "A String", # Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. **Note**: if the merchant sells the same product new and used, they should have different IDs. @@ -123,11 +123,11 @@

Method Details

Returns: An object of the form: - { # Local Inventory for the merchant. + { # Local Inventory for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "availability": "A String", # Required. Availability of the product at this store. For accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342) "collectionTime": "A String", # Optional. The time when the inventory is collected. If not set, it will be set to the time when the inventory is submitted. "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. - "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`. + "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`. "gtin": "A String", # Optional. The Global Trade Item Number of the product. "name": "A String", # Output only. Identifier. The name for the `LfpInventory` resource. Format: `accounts/{account}/lfpInventories/{target_merchant}~{store_code}~{offer}` "offerId": "A String", # Required. Immutable. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. **Note**: if the merchant sells the same product new and used, they should have different IDs. diff --git a/docs/dyn/merchantapi_lfp_v1.accounts.lfpMerchantStates.html b/docs/dyn/merchantapi_lfp_v1.accounts.lfpMerchantStates.html index f7137df08c..5ad195ac70 100644 --- a/docs/dyn/merchantapi_lfp_v1.accounts.lfpMerchantStates.html +++ b/docs/dyn/merchantapi_lfp_v1.accounts.lfpMerchantStates.html @@ -100,7 +100,7 @@

Method Details

Returns: An object of the form: - { # The LFP state of a merchant. + { # The LFP state of a merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "countrySettings": [ # Country-specific settings for the merchant. { # Country-specific settings for the merchant. "freeLocalListingsEnabled": True or False, # True if this merchant has enabled free local listings in MC. diff --git a/docs/dyn/merchantapi_lfp_v1.accounts.lfpSales.html b/docs/dyn/merchantapi_lfp_v1.accounts.lfpSales.html index 6a8b50e9a7..62606899c8 100644 --- a/docs/dyn/merchantapi_lfp_v1.accounts.lfpSales.html +++ b/docs/dyn/merchantapi_lfp_v1.accounts.lfpSales.html @@ -95,9 +95,9 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A sale for the merchant. +{ # A sale for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. - "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`. + "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`. "gtin": "A String", # Required. The Global Trade Item Number of the sold product. "name": "A String", # Output only. Identifier. The name of the `LfpSale` resource. Format: `accounts/{account}/lfpSales/{sale}` "offerId": "A String", # Required. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. **Note**: if the merchant sells the same product new and used, they should have different IDs. @@ -121,9 +121,9 @@

Method Details

Returns: An object of the form: - { # A sale for the merchant. + { # A sale for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "contentLanguage": "A String", # Required. The two-letter ISO 639-1 language code for the item. - "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`. + "feedLabel": "A String", # Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`. "gtin": "A String", # Required. The Global Trade Item Number of the sold product. "name": "A String", # Output only. Identifier. The name of the `LfpSale` resource. Format: `accounts/{account}/lfpSales/{sale}` "offerId": "A String", # Required. A unique identifier for the product. If both inventories and sales are submitted for a merchant, this id should match for the same product. **Note**: if the merchant sells the same product new and used, they should have different IDs. diff --git a/docs/dyn/merchantapi_lfp_v1.accounts.lfpStores.html b/docs/dyn/merchantapi_lfp_v1.accounts.lfpStores.html index b58c1af4f7..31cab1812a 100644 --- a/docs/dyn/merchantapi_lfp_v1.accounts.lfpStores.html +++ b/docs/dyn/merchantapi_lfp_v1.accounts.lfpStores.html @@ -130,7 +130,7 @@

Method Details

Returns: An object of the form: - { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. + { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "gcidCategory": [ # Optional. [Google My Business category id](https://support.google.com/business/answer/7249669). "A String", ], @@ -156,7 +156,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. +{ # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "gcidCategory": [ # Optional. [Google My Business category id](https://support.google.com/business/answer/7249669). "A String", ], @@ -180,7 +180,7 @@

Method Details

Returns: An object of the form: - { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. + { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "gcidCategory": [ # Optional. [Google My Business category id](https://support.google.com/business/answer/7249669). "A String", ], @@ -216,7 +216,7 @@

Method Details

{ # Response message for the ListLfpStores method. "lfpStores": [ # The stores from the specified merchant. - { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. + { # A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview). "gcidCategory": [ # Optional. [Google My Business category id](https://support.google.com/business/answer/7249669). "A String", ], diff --git a/docs/dyn/merchantapi_loyaltycustomers_v1.accounts.loyaltyCustomers.html b/docs/dyn/merchantapi_loyaltycustomers_v1.accounts.loyaltyCustomers.html index 21d4120b3c..128595089f 100644 --- a/docs/dyn/merchantapi_loyaltycustomers_v1.accounts.loyaltyCustomers.html +++ b/docs/dyn/merchantapi_loyaltycustomers_v1.accounts.loyaltyCustomers.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.

+

Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](https://developers.google.com/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.

Method Details

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

Method Details

manage(parent, body=None, x__xgafv=None) -
Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.
+  
Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](https://developers.google.com/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.
 
 Args:
   parent: string, Required. The parent account where this loyalty customer will be handled. Format: `accounts/{account}` (required)
diff --git a/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html b/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html
index 770b196faa..bebd231f77 100644
--- a/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html
+++ b/docs/dyn/merchantapi_notifications_v1.accounts.notificationsubscriptions.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

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

-

Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

+

Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.

delete(name, x__xgafv=None)

Deletes a notification subscription for a merchant.

@@ -103,14 +103,14 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
+  
Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple "partial" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple "all managed accounts" subscriptions. 3. "All managed accounts" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.
 
 Args:
   parent: string, Required. The merchant account that owns the new notification subscription. Format: `accounts/{account}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.
+{ # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.
   "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
   "callBackUri": "A String", # URL to be used to push the notification to the merchant.
   "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}`
@@ -126,7 +126,7 @@ 

Method Details

Returns: An object of the form: - { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. + { # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` @@ -167,7 +167,7 @@

Method Details

Returns: An object of the form: - { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. + { # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` @@ -195,7 +195,7 @@

Method Details

{ # Response message for the ListNotificationSubscription method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "notificationSubscriptions": [ # The list of notification subscriptions requested by the merchant. - { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. + { # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` @@ -229,7 +229,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. +{ # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` @@ -246,7 +246,7 @@

Method Details

Returns: An object of the form: - { # Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. + { # Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. "allManagedAccounts": True or False, # If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. "callBackUri": "A String", # URL to be used to push the notification to the merchant. "name": "A String", # Output only. The `name` of the notification configuration. Generated by the Merchant API upon creation of a new `NotificationSubscription`. The `account` represents the merchant ID of the merchant that owns the configuration. Format: `accounts/{account}/notificationsubscriptions/{notification_subscription}` diff --git a/docs/dyn/merchantapi_ordertracking_v1.accounts.orderTrackingSignals.html b/docs/dyn/merchantapi_ordertracking_v1.accounts.orderTrackingSignals.html index 7b2f1b5477..8286611a8e 100644 --- a/docs/dyn/merchantapi_ordertracking_v1.accounts.orderTrackingSignals.html +++ b/docs/dyn/merchantapi_ordertracking_v1.accounts.orderTrackingSignals.html @@ -95,7 +95,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Represents a business trade from which signals are extracted, such as shipping. +{ # Represents a business trade from which signals are extracted, such as shipping. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview). "customerShippingFee": { # The price represented as a number and currency. # Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -115,7 +115,7 @@

Method Details

"quantity": "A String", # Required. The quantity of the line item in the order. }, ], - "merchantId": "A String", # Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals). + "merchantId": "A String", # Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview). "orderCreatedTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Required. The time when the order was created on the businesses side. Include the year and timezone string, if available. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. @@ -217,7 +217,7 @@

Method Details

Returns: An object of the form: - { # Represents a business trade from which signals are extracted, such as shipping. + { # Represents a business trade from which signals are extracted, such as shipping. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview). "customerShippingFee": { # The price represented as a number and currency. # Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -237,7 +237,7 @@

Method Details

"quantity": "A String", # Required. The quantity of the line item in the order. }, ], - "merchantId": "A String", # Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals). + "merchantId": "A String", # Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview). "orderCreatedTime": { # Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. # Required. The time when the order was created on the businesses side. Include the year and timezone string, if available. "day": 42, # Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. "hours": 42, # Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. diff --git a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html index 119912aedb..f6a0a6bba5 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1.accounts.productInputs.html @@ -82,10 +82,10 @@

Instance Methods

Deletes a product input from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

insert(parent, body=None, dataSource=None, x__xgafv=None)

-

[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

+

[Uploads a product input to your Merchant Center account](https://developers.google.com/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

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

-

Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

+

Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. For more information, see [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage) and [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates).

Method Details

close() @@ -113,14 +113,14 @@

Method Details

insert(parent, body=None, dataSource=None, x__xgafv=None) -
[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
+  
[Uploads a product input to your Merchant Center account](https://developers.google.com/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
 
 Args:
   parent: string, Required. The account where this product will be inserted. Format: `accounts/{account}` (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
+{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates), and [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
   "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get).
   "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).
   "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
@@ -570,7 +570,7 @@ 

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. @@ -656,7 +656,7 @@

Method Details

"versionNumber": "A String", # Optional. Immutable. Represents the existing version (freshness) of the product, which can be used to preserve the right order when multiple updates are done at the same time. If set, the insertion is prevented when version number is lower than the current version number of the existing product. Re-insertion (for example, product refresh after 30 days) can be performed with the current `version_number`. Only supported for insertions into primary data sources. Do not set this field for updates. Do not set this field for insertions into supplemental data sources. If the operation is prevented, the aborted exception will be thrown. } - dataSource: string, Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Create a primary data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`. + dataSource: string, Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Create a primary data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -665,7 +665,7 @@

Method Details

Returns: An object of the form: - { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. + { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates), and [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get). "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. @@ -1115,7 +1115,7 @@

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. @@ -1204,14 +1204,14 @@

Method Details

patch(name, body=None, dataSource=None, updateMask=None, x__xgafv=None) -
Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.
+  
Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. For more information, see [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage) and [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates).
 
 Args:
   name: string, Identifier. The name of the product. Format: `accounts/{account}/productInputs/{productinput}` The {productinput} segment is a unique identifier for the product. This identifier must be unique within a merchant account and generally follows the structure: `content_language~feed_label~offer_id`. Example: `en~US~sku123` For legacy local products, the structure is: `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123` The format of the {productinput} segment in the URL is automatically detected by the server, supporting two options: 1. **Encoded Format**: The `{productinput}` segment is an unpadded base64url encoded string (RFC 4648 Section 5). The decoded string must result in the `content_language~feed_label~offer_id` structure. This encoding MUST be used if any part of the product identifier (like `offer_id`) contains characters such as `/`, `%`, or `~`. * Example: To represent the product ID `en~US~sku/123`, the `{productinput}` segment must be the unpadded base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name for the product would be `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw`. 2. **Plain Format**: The `{productinput}` segment is the tilde-separated string `content_language~feed_label~offer_id`. This format is suitable only when `content_language`, `feed_label`, and `offer_id` do not contain URL-problematic characters like `/`, `%`, or `~`. We recommend using the **Encoded Format** for all product IDs to ensure correct parsing, especially those containing special characters. The presence of tilde (`~`) characters in the `{productinput}` segment is used to differentiate between the two formats. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
+{ # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates), and [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.
   "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get).
   "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get).
   "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
@@ -1661,7 +1661,7 @@ 

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. @@ -1757,7 +1757,7 @@

Method Details

Returns: An object of the form: - { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. + { # This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates), and [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style. "base64EncodedName": "A String", # Output only. The **unpadded base64url encoded name** of the product input. Format: `accounts/{account}/productInputs/{productinput}` where the last section `productinput` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/productInputs/ZW5-VVN-c2t1LzEyMw` for the decoded product input name `accounts/123/productInputs/en~US~sku/123`. This field can be used directly as input to the API methods that require the product input name to be encoded if it contains special characters, for example [`GetProductInput`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.productInputs/get). "base64EncodedProduct": "A String", # Output only. The **unpadded base64url encoded name** of the processed product. Format: `accounts/{account}/products/{product}` where the last section `product` is the unpadded base64url encoding of the `content_language~feed_label~offer_id` name. Example: `accounts/123/products/ZW5-VVN-c2t1LzEyMw` for the decoded product name `accounts/123/products/en~US~sku/123`. This field can be used directly as input to the API methods that require the product name to be encoded if it contains special characters, for example [`GetProduct`](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products/get). "contentLanguage": "A String", # Required. Immutable. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product. @@ -2207,7 +2207,7 @@

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html index 4ba5349889..1f6e2494c0 100644 --- a/docs/dyn/merchantapi_products_v1.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1.accounts.products.html @@ -82,7 +82,7 @@

Instance Methods

Retrieves the processed product from your Merchant Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

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

-

Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

+

Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. For more information, see [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues).

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. + { # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. For product ingestion workflows and status checks, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), and [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues). "archived": True or False, # Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713). "automatedDiscounts": { # Information regarding Automated Discounts. # Output only. The automated discounts information for the product. "gadPrice": { # The price represented as a number and currency. # The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available. @@ -570,7 +570,7 @@

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. @@ -693,7 +693,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.
+  
Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. For more information, see [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues).
 
 Args:
   parent: string, Required. The account to list processed products for. Format: `accounts/{account}` (required)
@@ -710,7 +710,7 @@ 

Method Details

{ # Response message for the ListProducts method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "products": [ # The processed products from the specified account. These are your processed products after applying rules and supplemental data sources. - { # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. + { # The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. For product ingestion workflows and status checks, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), and [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues). "archived": True or False, # Output only. Determines whether the product is [archived](https://support.google.com/merchants/answer/11909930). To archive or restore your product, visit Merchant Center products page. Learn also more about [offer visibility](https://support.google.com/merchants/answer/12488713). "automatedDiscounts": { # Information regarding Automated Discounts. # Output only. The automated discounts information for the product. "gadPrice": { # The price represented as a number and currency. # The current sale price for products with a price optimized using Google Automated Discounts (GAD). Absent if the information about the GAD_price of the product is not available. @@ -1174,7 +1174,7 @@

Method Details

"shortTitle": "A String", # The short title of the item. "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 [Size](https://support.google.com/merchants/answer/6324492). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. For more information, see [Size system](https://support.google.com/merchants/answer/6324502). - "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). + "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `["PETITE", "MATERNITY"]` or `["BIG", "TALL"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497). "A String", ], "specialtyHousingType": "A String", # The specialty housing type for the property. diff --git a/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html b/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html index 747e68bc84..f0e2009a03 100644 --- a/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html +++ b/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html @@ -109,7 +109,7 @@

Method Details

Returns: An object of the form: - { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. + { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. For more information, see [Manage promotions](https://developers.google.com/merchant/api/guides/promotions/overview) and [Troubleshoot issues](https://developers.google.com/merchant/api/guides/promotions/troubleshooting). "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). @@ -206,7 +206,7 @@

Method Details

"A String", ], }, - "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=). + "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281#option3&zippy=). "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -218,7 +218,7 @@

Method Details

], "dataSource": "A String", # Output only. The primary data source of the promotion. "name": "A String", # Identifier. The name of the promotion. Format: `accounts/{account}/promotions/{promotion}` - "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements) to prevent promotion disapprovals. + "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148#minimum_requirements) to prevent promotion disapprovals. "promotionStatus": { # The status of the promotion. # Output only. The [status of a promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC), data validation issues, that is, information about a promotion computed asynchronously. "creationDate": "A String", # Output only. Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example `2020-01-02T09:00:00+01:00` or `2020-01-02T09:00:00Z` "destinationStatuses": [ # Output only. The intended destinations for the promotion. @@ -263,7 +263,7 @@

Method Details

{ # Request message for the `InsertPromotion` method. "dataSource": "A String", # Required. The data source of the [promotion](https://support.google.com/merchants/answer/6396268?sjid=5155774230887277618-NC) Format: `accounts/{account}/dataSources/{datasource}`. - "promotion": { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. # Required. The promotion to insert. + "promotion": { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. For more information, see [Manage promotions](https://developers.google.com/merchant/api/guides/promotions/overview) and [Troubleshoot issues](https://developers.google.com/merchant/api/guides/promotions/troubleshooting). # Required. The promotion to insert. "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). @@ -360,7 +360,7 @@

Method Details

"A String", ], }, - "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=). + "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281#option3&zippy=). "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -372,7 +372,7 @@

Method Details

], "dataSource": "A String", # Output only. The primary data source of the promotion. "name": "A String", # Identifier. The name of the promotion. Format: `accounts/{account}/promotions/{promotion}` - "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements) to prevent promotion disapprovals. + "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148#minimum_requirements) to prevent promotion disapprovals. "promotionStatus": { # The status of the promotion. # Output only. The [status of a promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC), data validation issues, that is, information about a promotion computed asynchronously. "creationDate": "A String", # Output only. Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example `2020-01-02T09:00:00+01:00` or `2020-01-02T09:00:00Z` "destinationStatuses": [ # Output only. The intended destinations for the promotion. @@ -414,7 +414,7 @@

Method Details

Returns: An object of the form: - { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. + { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. For more information, see [Manage promotions](https://developers.google.com/merchant/api/guides/promotions/overview) and [Troubleshoot issues](https://developers.google.com/merchant/api/guides/promotions/troubleshooting). "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). @@ -511,7 +511,7 @@

Method Details

"A String", ], }, - "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=). + "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281#option3&zippy=). "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -523,7 +523,7 @@

Method Details

], "dataSource": "A String", # Output only. The primary data source of the promotion. "name": "A String", # Identifier. The name of the promotion. Format: `accounts/{account}/promotions/{promotion}` - "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements) to prevent promotion disapprovals. + "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148#minimum_requirements) to prevent promotion disapprovals. "promotionStatus": { # The status of the promotion. # Output only. The [status of a promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC), data validation issues, that is, information about a promotion computed asynchronously. "creationDate": "A String", # Output only. Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example `2020-01-02T09:00:00+01:00` or `2020-01-02T09:00:00Z` "destinationStatuses": [ # Output only. The intended destinations for the promotion. @@ -576,7 +576,7 @@

Method Details

{ # Response message for the `ListPromotions` method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "promotions": [ # The processed promotions from the specified account. - { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. + { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. For more information, see [Manage promotions](https://developers.google.com/merchant/api/guides/promotions/overview) and [Troubleshoot issues](https://developers.google.com/merchant/api/guides/promotions/troubleshooting). "attributes": { # Attributes. # Optional. A list of promotion attributes. "audience": "A String", # Optional. This field defines the audience a promotion will be visible to. "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). @@ -673,7 +673,7 @@

Method Details

"A String", ], }, - "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=). + "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281#option3&zippy=). "customAttributes": [ # Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API. { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty. "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty. @@ -685,7 +685,7 @@

Method Details

], "dataSource": "A String", # Output only. The primary data source of the promotion. "name": "A String", # Identifier. The name of the promotion. Format: `accounts/{account}/promotions/{promotion}` - "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements) to prevent promotion disapprovals. + "promotionId": "A String", # Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148#minimum_requirements) to prevent promotion disapprovals. "promotionStatus": { # The status of the promotion. # Output only. The [status of a promotion](https://support.google.com/merchants/answer/3398326?ref_topic=7322924&sjid=5155774230887277618-NC), data validation issues, that is, information about a promotion computed asynchronously. "creationDate": "A String", # Output only. Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example `2020-01-02T09:00:00+01:00` or `2020-01-02T09:00:00Z` "destinationStatuses": [ # Output only. The intended destinations for the promotion. diff --git a/docs/dyn/merchantapi_quota_v1.accounts.limits.html b/docs/dyn/merchantapi_quota_v1.accounts.limits.html index 447c53cca8..42b1046d39 100644 --- a/docs/dyn/merchantapi_quota_v1.accounts.limits.html +++ b/docs/dyn/merchantapi_quota_v1.accounts.limits.html @@ -106,7 +106,7 @@

Method Details

Returns: An object of the form: - { # A limit of a certain type that is applied to an account. + { # A limit of a certain type that is applied to an account. For more information, see [Quotas and limits overview](https://developers.google.com/merchant/api/guides/quotas-limits/overview) and [Merchant Center limits](https://developers.google.com/merchant/api/guides/quotas-limits/limits). "name": "A String", # Identifier. The limit part of the name will be a combination of the type and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA` Format: `accounts/{account}/limits/{limit}` "products": { # The limit for products. # The limit for products. "limit": "A String", # Required. The maximum number of products that are allowed in the account in the given scope. @@ -134,7 +134,7 @@

Method Details

{ # Response message for the `ListAccountLimits` method. "accountLimits": [ # The limits for the given account. - { # A limit of a certain type that is applied to an account. + { # A limit of a certain type that is applied to an account. For more information, see [Quotas and limits overview](https://developers.google.com/merchant/api/guides/quotas-limits/overview) and [Merchant Center limits](https://developers.google.com/merchant/api/guides/quotas-limits/limits). "name": "A String", # Identifier. The limit part of the name will be a combination of the type and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA` Format: `accounts/{account}/limits/{limit}` "products": { # The limit for products. # The limit for products. "limit": "A String", # Required. The maximum number of products that are allowed in the account in the given scope. diff --git a/docs/dyn/merchantapi_quota_v1.accounts.quotas.html b/docs/dyn/merchantapi_quota_v1.accounts.quotas.html index a20a611cbc..ef99fd7096 100644 --- a/docs/dyn/merchantapi_quota_v1.accounts.quotas.html +++ b/docs/dyn/merchantapi_quota_v1.accounts.quotas.html @@ -108,7 +108,7 @@

Method Details

{ # Response message for the ListMethodGroups method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "quotaGroups": [ # The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage. - { # The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned. + { # The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned. For more information, see [Quotas and limits overview](https://developers.google.com/merchant/api/guides/quotas-limits/overview) and [Quotas](https://developers.google.com/merchant/api/guides/quotas-limits/quotas). "methodDetails": [ # Output only. List of all methods group quota applies to. { # The method details per method in the Merchant API. "method": "A String", # Output only. The name of the method for example `products.list`. diff --git a/docs/dyn/merchantapi_reports_v1.accounts.reports.html b/docs/dyn/merchantapi_reports_v1.accounts.reports.html index 4f2641bf19..46323124b7 100644 --- a/docs/dyn/merchantapi_reports_v1.accounts.reports.html +++ b/docs/dyn/merchantapi_reports_v1.accounts.reports.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested.

+

Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested. For more information, see [Get started](https://developers.google.com/merchant/api/guides/reports/get-started), [Use Merchant Center Query Language](https://developers.google.com/merchant/api/guides/reports/query-language), and [Paginate query results](https://developers.google.com/merchant/api/guides/reports/paging).

search_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -91,7 +91,7 @@

Method Details

search(parent, body=None, x__xgafv=None) -
Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested.
+  
Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested. For more information, see [Get started](https://developers.google.com/merchant/api/guides/reports/get-started), [Use Merchant Center Query Language](https://developers.google.com/merchant/api/guides/reports/query-language), and [Paginate query results](https://developers.google.com/merchant/api/guides/reports/paging).
 
 Args:
   parent: string, Required. Id of the account making the call. Must be a standalone account or a subaccount of an advanced account. Format: accounts/{account} (required)
@@ -101,7 +101,7 @@ 

Method Details

{ # Request message for the `ReportService.Search` method. "pageSize": 42, # Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000. "pageToken": "A String", # Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used. - "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields. + "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields. } x__xgafv: string, V1 error format. @@ -115,8 +115,8 @@

Method Details

{ # Response message for the `ReportService.Search` method. "nextPageToken": "A String", # Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages. "results": [ # Rows that matched the search query. - { # Result row returned from the search query. Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated. - "bestSellersBrandView": { # Fields available for query in `best_sellers_brand_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top brands. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `best_sellers_brand_view` table. + { # Result row returned from the search query. Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated. For more information, see [Reports overview](https://developers.google.com/merchant/api/guides/reports/overview) and [Use Merchant Center Query Language](https://developers.google.com/merchant/api/guides/reports/query-language). + "bestSellersBrandView": { # Fields available for query in `best_sellers_brand_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top brands. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market). # Fields available for query in `best_sellers_brand_view` table. "brand": "A String", # Name of the brand. "previousRank": "A String", # Popularity rank in the previous week or month. "previousRelativeDemand": "A String", # Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month. @@ -132,7 +132,7 @@

Method Details

}, "reportGranularity": "A String", # Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the `SELECT` clause. Condition on `report_granularity` is required in the `WHERE` clause. }, - "bestSellersProductClusterView": { # Fields available for query in `best_sellers_product_cluster_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `best_sellers_product_cluster_view` table. + "bestSellersProductClusterView": { # Fields available for query in `best_sellers_product_cluster_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market). # Fields available for query in `best_sellers_product_cluster_view` table. "brand": "A String", # Brand of the product cluster. "brandInventoryStatus": "A String", # Whether there is at least one product of the brand currently `IN_STOCK` in your product data source in at least one of the countries, all products are `OUT_OF_STOCK` in your product data source in all countries, or `NOT_IN_INVENTORY`. The field doesn't take the Best sellers report country filter into account. "categoryL1": "A String", # Product category (1st level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). @@ -159,7 +159,7 @@

Method Details

"A String", ], }, - "competitiveVisibilityBenchmarkView": { # Fields available for query in `competitive_visibility_benchmark_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with the category benchmark. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `competitive_visibility_benchmark_view` table. + "competitiveVisibilityBenchmarkView": { # Fields available for query in `competitive_visibility_benchmark_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with the category benchmark. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape). # Fields available for query in `competitive_visibility_benchmark_view` table. "categoryBenchmarkVisibilityTrend": 3.14, # Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market. Cannot be filtered on in the 'WHERE' clause. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date of this row. Required in the `SELECT` clause. A condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -171,7 +171,7 @@

Method Details

"trafficSource": "A String", # Traffic source of impressions. Required in the `SELECT` clause. "yourDomainVisibilityTrend": 3.14, # Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Cannot be filtered on in the 'WHERE' clause. }, - "competitiveVisibilityCompetitorView": { # Fields available for query in `competitive_visibility_competitor_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `competitive_visibility_competitor_view` table. + "competitiveVisibilityCompetitorView": { # Fields available for query in `competitive_visibility_competitor_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape). # Fields available for query in `competitive_visibility_competitor_view` table. "adsOrganicRatio": 3.14, # [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date of this row. A condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -188,7 +188,7 @@

Method Details

"reportCountryCode": "A String", # Country where impressions appeared. Required in the `SELECT` clause. A condition on `report_country_code` is required in the `WHERE` clause. "trafficSource": "A String", # Traffic source of impressions. Required in the `SELECT` clause. }, - "competitiveVisibilityTopMerchantView": { # Fields available for query in `competitive_visibility_top_merchant_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with business with highest visibility. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `competitive_visibility_top_merchant_view` table. + "competitiveVisibilityTopMerchantView": { # Fields available for query in `competitive_visibility_top_merchant_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with business with highest visibility. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape). # Fields available for query in `competitive_visibility_top_merchant_view` table. "adsOrganicRatio": 3.14, # [Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date of this row. Cannot be selected in the `SELECT` clause. A condition on `date` is required in the `WHERE` clause. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. @@ -204,7 +204,7 @@

Method Details

"reportCountryCode": "A String", # Country where impressions appeared. Required in the `SELECT` clause. A condition on `report_country_code` is required in the `WHERE` clause. "trafficSource": "A String", # Traffic source of impressions. Required in the `SELECT` clause. }, - "nonProductPerformanceView": { # Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `non_product_performance_view` table. + "nonProductPerformanceView": { # Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information, see [Performance reports](https://developers.google.com/merchant/api/guides/reports/performance-reports). # Fields available for query in `non_product_performance_view` table. "clickThroughRate": 3.14, # Click-through rate - the number of clicks (`clicks`) divided by the number of impressions (`impressions`) of images and online store links leading to your non-product pages. Metric. "clicks": "A String", # Number of clicks on images and online store links leading to your non-product pages. Metric. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause. @@ -219,7 +219,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "priceCompetitivenessProductView": { # Fields available for query in `price_competitiveness_product_view` table. [Price competitiveness](https://support.google.com/merchants/answer/9626903) report. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `price_competitiveness_product_view` table. + "priceCompetitivenessProductView": { # Fields available for query in `price_competitiveness_product_view` table. [Price competitiveness](https://support.google.com/merchants/answer/9626903) report. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market). # Fields available for query in `price_competitiveness_product_view` table. "benchmarkPrice": { # The price represented as a number and currency. # Latest available price benchmark for the product's catalog in the benchmark country. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -244,7 +244,7 @@

Method Details

"reportCountryCode": "A String", # Country of the price benchmark. Represented in the ISO 3166 format. Required in the `SELECT` clause. "title": "A String", # Title of the product. }, - "priceInsightsProductView": { # Fields available for query in `price_insights_product_view` table. [Price insights](https://support.google.com/merchants/answer/11916926) report. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `price_insights_product_view` table. + "priceInsightsProductView": { # Fields available for query in `price_insights_product_view` table. [Price insights](https://support.google.com/merchants/answer/11916926) report. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market). # Fields available for query in `price_insights_product_view` table. "brand": "A String", # Brand of the product. "categoryL1": "A String", # Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). "categoryL2": "A String", # Product category (2nd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). @@ -272,13 +272,13 @@

Method Details

}, "title": "A String", # Title of the product. }, - "productPerformanceView": { # Fields available for query in `product_performance_view` table. Product performance data for your account, including performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `offer_id`). Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_performance_view` table. + "productPerformanceView": { # Fields available for query in `product_performance_view` table. Product performance data for your account, including performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `offer_id`). Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information, see [Performance reports](https://developers.google.com/merchant/api/guides/reports/performance-reports). # Fields available for query in `product_performance_view` table. "brand": "A String", # Brand of the product. Segment. - "categoryL1": "A String", # [Product category (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment. - "categoryL2": "A String", # [Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment. - "categoryL3": "A String", # [Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment. - "categoryL4": "A String", # [Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment. - "categoryL5": "A String", # [Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment. + "categoryL1": "A String", # [Product category (1st level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment. + "categoryL2": "A String", # [Product category (2nd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment. + "categoryL3": "A String", # [Product category (3rd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment. + "categoryL4": "A String", # [Product category (4th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment. + "categoryL5": "A String", # [Product category (5th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment. "clickThroughRate": 3.14, # Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric. "clicks": "A String", # Number of clicks. Metric. "conversionRate": 3.14, # Number of conversions divided by the number of clicks, reported on the impression date. Metric. Available only for the `FREE` traffic source. @@ -302,11 +302,11 @@

Method Details

"marketingMethod": "A String", # Marketing method to which metrics apply. Segment. "network": "A String", # Network to which metrics apply. Segment. "offerId": "A String", # Merchant-provided id of the product. Segment. - "productTypeL1": "A String", # [Product type (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. - "productTypeL2": "A String", # [Product type (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. - "productTypeL3": "A String", # [Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. - "productTypeL4": "A String", # [Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. - "productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment. + "productTypeL1": "A String", # [Product type (1st level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment. + "productTypeL2": "A String", # [Product type (2nd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment. + "productTypeL3": "A String", # [Product type (3rd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment. + "productTypeL4": "A String", # [Product type (4th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment. + "productTypeL5": "A String", # [Product type (5th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment. "storeType": "A String", # Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available. "title": "A String", # Title of the product. Segment. "week": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment. @@ -315,7 +315,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_view` table. + "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. For more information, see [Evaluate your products](https://developers.google.com/merchant/api/guides/reports/evaluate-products). # Fields available for query in `product_view` table. "aggregatedReportingContextStatus": "A String", # Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field. "availability": "A String", # [Availability](https://support.google.com/merchants/answer/6324448) of the product. "brand": "A String", # Brand of the product. @@ -359,7 +359,7 @@

Method Details

}, "type": { # Issue type. # Item issue type. "canonicalAttribute": "A String", # Canonical attribute name for attribute-specific issues. - "code": "A String", # Error code of the issue, equivalent to the `code` of [Product issues](https://developers.google.com/shopping-content/guides/product-issues). + "code": "A String", # Error code of the issue, equivalent to the `code` of [Product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues). }, }, ], diff --git a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html index 0ff70255c7..e6660b792f 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.accounts.locations.html @@ -153,7 +153,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -166,7 +166,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -389,7 +389,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -402,7 +402,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -637,7 +637,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -650,7 +650,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html index 6333c3200a..8e25bca5b7 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.googleLocations.html @@ -147,7 +147,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -160,7 +160,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -387,7 +387,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -400,7 +400,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. diff --git a/docs/dyn/mybusinessbusinessinformation_v1.locations.html b/docs/dyn/mybusinessbusinessinformation_v1.locations.html index 6d86741a01..9c1996387a 100644 --- a/docs/dyn/mybusinessbusinessinformation_v1.locations.html +++ b/docs/dyn/mybusinessbusinessinformation_v1.locations.html @@ -191,7 +191,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -204,7 +204,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -476,7 +476,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -489,7 +489,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -714,7 +714,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -727,7 +727,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. @@ -950,7 +950,7 @@

Method Details

}, "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information. "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API. - "canHaveBusinessCalls": True or False, # Output only. Indicates if the listing is eligible for business calls. + "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls. "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu. "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list. "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data. @@ -963,7 +963,7 @@

Method Details

"isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441). "mapsUri": "A String", # Output only. A link to the location on Maps. "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location. - "placeId": "A String", # Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. + "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update. }, "moreHours": [ # Optional. More hours for a business's different departments or specific customers. { # The time periods during which a location is open for certain types of business. diff --git a/docs/dyn/mybusinessbusinessinformation_v1alpha.accounts.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.accounts.html new file mode 100644 index 0000000000..c2b92ae2dd --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.accounts.html @@ -0,0 +1,91 @@ + + + +

My Business Business Information API . accounts

+

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/mybusinessbusinessinformation_v1alpha.accounts.locations.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.accounts.locations.html new file mode 100644 index 0000000000..a2bb5fff8f --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.accounts.locations.html @@ -0,0 +1,833 @@ + + + +

My Business Business Information API . accounts . locations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new Location that will be owned by the logged in user.

+

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

+

Lists the locations for the specified account.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, requestId=None, validateOnly=None, x__xgafv=None) +
Creates a new Location that will be owned by the logged in user.
+
+Args:
+  parent: string, Required. The name of the account in which to create this location. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+  "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+    "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+  },
+  "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+    "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+      { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    ],
+    "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  },
+  "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+    "A String",
+  ],
+  "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+  "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+    "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+    "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+    "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+    "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+    "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+    "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+    "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+    "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+    "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+    "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+    "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+    "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+    "mapsUri": "A String", # Output only. A link to the location on Maps.
+    "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+    "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+  },
+  "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+    { # The time periods during which a location is open for certain types of business.
+      "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+      "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+  "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+    "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+    "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+  },
+  "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+    "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+      "A String",
+    ],
+    "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+  },
+  "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+    "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+  },
+  "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+    "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+      { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+        "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+    ],
+  },
+  "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+    "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+      { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    ],
+    "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+    "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+      "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+      "relationType": "A String", # Required. The type of the relationship.
+    },
+  },
+  "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+    "businessType": "A String", # Required. Indicates the type of the service area business.
+    "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+      "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+        { # Defines an area that's represented by a place ID.
+          "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+          "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+        },
+      ],
+    },
+    "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+  },
+  "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+    { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+      "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+        "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+        "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+          "description": "A String", # Optional. Description of the price list, section, or item.
+          "displayName": "A String", # Required. Display name for the price list, section, or item.
+          "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+        },
+      },
+      "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+        "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.
+      },
+      "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+        "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+        "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+      },
+    },
+  ],
+  "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+    "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+      { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+        "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+    ],
+  },
+  "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+  "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+  },
+  "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+  "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+}
+
+  requestId: string, Optional. A unique request ID for the server to detect duplicated requests. We recommend using UUIDs. Max length is 50 characters.
+  validateOnly: boolean, Optional. If true, the request is validated without actually creating the location.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+  "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+    "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+  },
+  "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+    "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+      { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    ],
+    "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  },
+  "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+    "A String",
+  ],
+  "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+  "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+    "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+    "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+    "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+    "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+    "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+    "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+    "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+    "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+    "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+    "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+    "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+    "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+    "mapsUri": "A String", # Output only. A link to the location on Maps.
+    "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+    "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+  },
+  "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+    { # The time periods during which a location is open for certain types of business.
+      "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+      "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+  "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+    "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+    "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+  },
+  "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+    "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+      "A String",
+    ],
+    "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+  },
+  "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+    "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+  },
+  "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+    "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+      { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+        "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+    ],
+  },
+  "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+    "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+      { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    ],
+    "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+    "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+      "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+      "relationType": "A String", # Required. The type of the relationship.
+    },
+  },
+  "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+    "businessType": "A String", # Required. Indicates the type of the service area business.
+    "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+      "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+        { # Defines an area that's represented by a place ID.
+          "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+          "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+        },
+      ],
+    },
+    "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+  },
+  "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+    { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+      "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+        "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+        "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+          "description": "A String", # Optional. Description of the price list, section, or item.
+          "displayName": "A String", # Required. Display name for the price list, section, or item.
+          "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+        },
+      },
+      "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+        "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.
+      },
+      "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+        "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+        "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+      },
+    },
+  ],
+  "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+    "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+      { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+        "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+    ],
+  },
+  "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+  "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+  },
+  "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+  "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists the locations for the specified account.
+
+Args:
+  parent: string, Required. The name of the account to fetch locations from. * **Specific Account ID**: If the account is of type `AccountType.PERSONAL`, the response returns only locations directly owned by that account. For all other types (e.g., `AccountType.LOCATION_GROUP`), it returns all accessible locations. * **Wildcard (`-`)**: Using `accounts/-` identifies the authenticated user. This scope defaults to `AccountType.PERSONAL` but includes both directly and indirectly owned locations (e.g., those accessible via member groups). (required)
+  filter: string, Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If `filter` is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see [Work with Location Data Guide](https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations).
+  orderBy: string, Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix " desc" should be added. Valid fields to order_by are title and store_code. For example: "title, store_code desc" or "title" or "store_code desc"
+  pageSize: integer, Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.
+  pageToken: string, Optional. If specified, it fetches the next `page` of locations. The page token is returned by previous calls to `ListLocations` when there were more locations than could fit in the requested page size.
+  readMask: string, Required. Read mask to specify what fields will be returned in the response.
+  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 Locations.ListLocations.
+  "locations": [ # The locations.
+    { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+      "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+        "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+      },
+      "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+        "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+          { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+            "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+            "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+              { # More hours types that a business can offers, in addition to its regular hours.
+                "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+                "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+                "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+              },
+            ],
+            "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+            "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+              { # A message describing a service type that the business offers.
+                "displayName": "A String", # Output only. The human-readable display name for the service type.
+                "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+              },
+            ],
+          },
+        ],
+        "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+          "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+          "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+            { # More hours types that a business can offers, in addition to its regular hours.
+              "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+              "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+              "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+            },
+          ],
+          "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+          "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+            { # A message describing a service type that the business offers.
+              "displayName": "A String", # Output only. The human-readable display name for the service type.
+              "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+            },
+          ],
+        },
+      },
+      "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+        "A String",
+      ],
+      "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+      "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+        "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+        "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+      },
+      "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+        "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+        "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+        "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+        "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+        "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+        "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+        "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+        "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+        "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+        "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+        "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+        "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+        "mapsUri": "A String", # Output only. A link to the location on Maps.
+        "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+        "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+      },
+      "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+        { # The time periods during which a location is open for certain types of business.
+          "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+          "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+            { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+              "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+              "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+              "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+        },
+      ],
+      "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+      "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+        "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+        "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+      },
+      "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+        "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+          "A String",
+        ],
+        "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+      },
+      "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+        "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+      },
+      "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+        "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+          { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+            "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+      },
+      "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+        "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+          { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+            "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+            "relationType": "A String", # Required. The type of the relationship.
+          },
+        ],
+        "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+        "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+          "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+          "relationType": "A String", # Required. The type of the relationship.
+        },
+      },
+      "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+        "businessType": "A String", # Required. Indicates the type of the service area business.
+        "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+          "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+            { # Defines an area that's represented by a place ID.
+              "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+              "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+            },
+          ],
+        },
+        "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+      },
+      "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+        { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+          "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+            "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+            "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+              "description": "A String", # Optional. Description of the price list, section, or item.
+              "displayName": "A String", # Required. Display name for the price list, section, or item.
+              "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+            },
+          },
+          "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+            "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.
+          },
+          "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+            "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+            "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+          },
+        },
+      ],
+      "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+        "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+          { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+            "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+              "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+              "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+              "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+            },
+          },
+        ],
+      },
+      "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+      "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+        "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+          "A String",
+        ],
+        "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+        "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+        "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+        "organization": "A String", # Optional. The name of the organization at the address.
+        "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+        "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+          "A String",
+        ],
+        "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+        "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+        "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+        "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+      },
+      "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+      "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+    },
+  ],
+  "nextPageToken": "A String", # If the number of locations exceeded the requested page size, this field is populated with a token to fetch the next page of locations on a subsequent call to `ListLocations`. If there are no more locations, this field is not present in the response.
+  "totalSize": 42, # The approximate number of Locations in the list irrespective of pagination. This field will only be returned if `filter` is used as a query parameter.
+}
+
+ +
+ 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/mybusinessbusinessinformation_v1alpha.attributes.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.attributes.html new file mode 100644 index 0000000000..77817683e8 --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.attributes.html @@ -0,0 +1,147 @@ + + + +

My Business Business Information API . attributes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ list(categoryName=None, languageCode=None, pageSize=None, pageToken=None, parent=None, regionCode=None, showAll=None, x__xgafv=None)

+

Returns the list of attributes that would be available for a location with the given primary category and country.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(categoryName=None, languageCode=None, pageSize=None, pageToken=None, parent=None, regionCode=None, showAll=None, x__xgafv=None) +
Returns the list of attributes that would be available for a location with the given primary category and country.
+
+Args:
+  categoryName: string, Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}` (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.
+  languageCode: string, Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.
+  pageSize: integer, How many attributes to include per page. Default is 200, minimum is 1.
+  pageToken: string, If specified, the next page of attribute metadata is retrieved.
+  parent: string, Optional. Resource name of the location to look up available attributes. If this field is set, `category_name`, `region_code`, `language_code` and `show_all` are not required and must not be set. Format: `locations/{location_id}` (e.g., `locations/1234567890`).
+  regionCode: string, Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not set.
+  showAll: boolean, Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for AttributesService.ListAttributeMetadata.
+  "attributeMetadata": [ # A collection of attribute metadata for the available attributes.
+    { # Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.
+      "deprecated": True or False, # If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.
+      "displayName": "A String", # The localized display name for the attribute, if available; otherwise, the English display name.
+      "groupDisplayName": "A String", # The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.
+      "parent": "A String", # The unique identifier for the attribute.
+      "repeatable": True or False, # If true, the attribute supports multiple values. If false, only a single value should be provided.
+      "valueMetadata": [ # For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.
+        { # Metadata for supported attribute values.
+          "displayName": "A String", # The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name. For example, for a "WiFi" enum attribute, this could contain "Paid" to represent paid Wi-Fi.
+          "value": "", # The attribute value.
+        },
+      ],
+      "valueType": "A String", # The value type for the attribute. Values set and retrieved should be expected to be of this type.
+    },
+  ],
+  "nextPageToken": "A String", # If the number of attributes exceeded the requested page size, this field will be populated with a token to fetch the next page of attributes on a subsequent call to `attributes.list`. If there are no more attributes, this field will not be present in the response.
+}
+
+ +
+ 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/mybusinessbusinessinformation_v1alpha.categories.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.categories.html new file mode 100644 index 0000000000..e7576a601a --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.categories.html @@ -0,0 +1,200 @@ + + + +

My Business Business Information API . categories

+

Instance Methods

+

+ batchGet(languageCode=None, names=None, regionCode=None, view=None, x__xgafv=None)

+

Returns a list of business categories for the provided language and GConcept ids.

+

+ close()

+

Close httplib2 connections.

+

+ list(filter=None, languageCode=None, pageSize=None, pageToken=None, regionCode=None, view=None, x__xgafv=None)

+

Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ batchGet(languageCode=None, names=None, regionCode=None, view=None, x__xgafv=None) +
Returns a list of business categories for the provided language and GConcept ids.
+
+Args:
+  languageCode: string, Required. The BCP 47 code of language that the category names should be returned in.
+  names: string, Required. At least one name must be set. The GConcept ids the localized category names should be returned for. To return details for more than one category, repeat this parameter in the request. (repeated)
+  regionCode: string, Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.
+  view: string, Required. Specifies which parts to the Category resource should be returned in the response.
+    Allowed values
+      CATEGORY_VIEW_UNSPECIFIED - Not specified, equivalent to CATEGORY_METADATA_ONLY.
+      BASIC - The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.
+      FULL - Returns all the fields in the response.
+  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 BusinessCategories.BatchGetBusinessCategories.
+  "categories": [ # Categories that match the GConcept ids provided in the request. They will not come in the same order as category ids in the request.
+    { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ list(filter=None, languageCode=None, pageSize=None, pageToken=None, regionCode=None, view=None, x__xgafv=None) +
Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').
+
+Args:
+  filter: string, Optional. Filter string from user. The only field that supported is `displayName`. Eg: `filter=displayName=foo`.
+  languageCode: string, Required. The BCP 47 code of language.
+  pageSize: integer, Optional. How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.
+  pageToken: string, Optional. If specified, the next page of categories will be fetched.
+  regionCode: string, Required. The ISO 3166-1 alpha-2 country code.
+  view: string, Required. Specifies which parts to the Category resource should be returned in the response.
+    Allowed values
+      CATEGORY_VIEW_UNSPECIFIED - Not specified, equivalent to CATEGORY_METADATA_ONLY.
+      BASIC - The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.
+      FULL - Returns all the fields in the response.
+  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 BusinessCategories.ListCategories.
+  "categories": [ # The matching categories based on the requested parameters.
+    { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to `ListCategories`.
+}
+
+ +
+ 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/mybusinessbusinessinformation_v1alpha.chains.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.chains.html new file mode 100644 index 0000000000..cd748420fd --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.chains.html @@ -0,0 +1,159 @@ + + + +

My Business Business Information API . chains

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.

+

+ search(chainName=None, pageSize=None, x__xgafv=None)

+

Searches the chain based on chain name.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.
+
+Args:
+  name: string, Required. The chain's resource name, in the format `chains/{chain_place_id}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A chain is a brand that your business's locations can be affiliated with.
+  "chainNames": [ # Names of the chain.
+    { # Name to be used when displaying the chain.
+      "displayName": "A String", # The display name for this chain.
+      "languageCode": "A String", # The BCP 47 code of language of the name.
+    },
+  ],
+  "locationCount": 42, # Number of locations that are part of this chain.
+  "name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
+  "websites": [ # Websites of the chain.
+    { # Url to be used when displaying the chain.
+      "uri": "A String", # The uri for this chain.
+    },
+  ],
+}
+
+ +
+ search(chainName=None, pageSize=None, x__xgafv=None) +
Searches the chain based on chain name.
+
+Args:
+  chainName: string, Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: "walmart", "wal-mart", "walmmmart", "沃尔玛"
+  pageSize: integer, The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.
+  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 Locations.SearchChains.
+  "chains": [ # Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.
+    { # A chain is a brand that your business's locations can be affiliated with.
+      "chainNames": [ # Names of the chain.
+        { # Name to be used when displaying the chain.
+          "displayName": "A String", # The display name for this chain.
+          "languageCode": "A String", # The BCP 47 code of language of the name.
+        },
+      ],
+      "locationCount": 42, # Number of locations that are part of this chain.
+      "name": "A String", # Required. The chain's resource name, in the format `chains/{chain_id}`.
+      "websites": [ # Websites of the chain.
+        { # Url to be used when displaying the chain.
+          "uri": "A String", # The uri for this chain.
+        },
+      ],
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessbusinessinformation_v1alpha.googleLocations.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.googleLocations.html new file mode 100644 index 0000000000..5c2a888a5b --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.googleLocations.html @@ -0,0 +1,570 @@ + + + +

My Business Business Information API . googleLocations

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ search(body=None, x__xgafv=None)

+

Search all of the possible locations that are a match to the specified request.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ search(body=None, x__xgafv=None) +
Search all of the possible locations that are a match to the specified request.
+
+Args:
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for GoogleLocations.SearchGoogleLocations.
+  "location": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # Location to search for. If provided, will find locations which match the provided location details, which must include a value for the title.
+    "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+      "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+    },
+    "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+      "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+        { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+          "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+          "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+            { # More hours types that a business can offers, in addition to its regular hours.
+              "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+              "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+              "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+            },
+          ],
+          "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+          "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+            { # A message describing a service type that the business offers.
+              "displayName": "A String", # Output only. The human-readable display name for the service type.
+              "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+            },
+          ],
+        },
+      ],
+      "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    },
+    "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+      "A String",
+    ],
+    "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+    "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+      "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+      "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+      "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+      "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+      "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+      "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+      "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+      "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+      "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+      "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+      "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+      "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+      "mapsUri": "A String", # Output only. A link to the location on Maps.
+      "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+      "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+    },
+    "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+      { # The time periods during which a location is open for certain types of business.
+        "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+        "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+          { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+            "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+      },
+    ],
+    "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+    "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+      "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+      "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+    },
+    "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+      "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+        "A String",
+      ],
+      "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+    },
+    "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+      "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+    },
+    "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+      "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+    "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+      "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+        { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+          "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+          "relationType": "A String", # Required. The type of the relationship.
+        },
+      ],
+      "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+      "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    },
+    "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+      "businessType": "A String", # Required. Indicates the type of the service area business.
+      "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+        "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+          { # Defines an area that's represented by a place ID.
+            "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+            "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+          },
+        ],
+      },
+      "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+    },
+    "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+      { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+        "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+          "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+          "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+            "description": "A String", # Optional. Description of the price list, section, or item.
+            "displayName": "A String", # Required. Display name for the price list, section, or item.
+            "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+          },
+        },
+        "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+          "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.
+        },
+        "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+          "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+          "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+        },
+      },
+    ],
+    "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+      "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+        { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+          "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+        },
+      ],
+    },
+    "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+    "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+      "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "A String",
+      ],
+      "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+      "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+      "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+      "organization": "A String", # Optional. The name of the organization at the address.
+      "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+      "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+        "A String",
+      ],
+      "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+      "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+      "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+      "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+    },
+    "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+    "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+  },
+  "pageSize": 42, # The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.
+  "query": "A String", # Text query to search for. The search results from a query string will be less accurate than if providing an exact location, but can provide more inexact matches.
+}
+
+  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 GoogleLocations.SearchGoogleLocations.
+  "googleLocations": [ # A collection of GoogleLocations that are potential matches to the specified request, listed in order from most to least accuracy.
+    { # Represents a Location that is present on Google. This can be a location that has been claimed by the user, someone else, or could be unclaimed.
+      "location": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # The sparsely populated Location information. This field can be re-used in CreateLocation if it is not currently claimed by a user.
+        "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+          "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+        },
+        "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+          "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+            { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+              "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+              "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+                { # More hours types that a business can offers, in addition to its regular hours.
+                  "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+                  "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+                  "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+                },
+              ],
+              "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+              "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+                { # A message describing a service type that the business offers.
+                  "displayName": "A String", # Output only. The human-readable display name for the service type.
+                  "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+                },
+              ],
+            },
+          ],
+          "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+            "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+            "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+              { # More hours types that a business can offers, in addition to its regular hours.
+                "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+                "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+                "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+              },
+            ],
+            "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+            "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+              { # A message describing a service type that the business offers.
+                "displayName": "A String", # Output only. The human-readable display name for the service type.
+                "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+              },
+            ],
+          },
+        },
+        "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+          "A String",
+        ],
+        "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+        "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+          "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+          "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+        },
+        "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+          "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+          "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+          "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+          "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+          "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+          "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+          "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+          "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+          "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+          "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+          "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+          "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+          "mapsUri": "A String", # Output only. A link to the location on Maps.
+          "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+          "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+        },
+        "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+          { # The time periods during which a location is open for certain types of business.
+            "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+            "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+              { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+                "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+                "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+                  "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                  "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                  "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+                "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+                  "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                  "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                  "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+          },
+        ],
+        "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+        "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+          "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+          "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+        },
+        "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+          "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+            "A String",
+          ],
+          "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+        },
+        "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+          "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+        },
+        "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+          "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+            { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+              "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+              "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+              "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+        },
+        "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+          "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+            { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+              "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+              "relationType": "A String", # Required. The type of the relationship.
+            },
+          ],
+          "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+          "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+            "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+            "relationType": "A String", # Required. The type of the relationship.
+          },
+        },
+        "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+          "businessType": "A String", # Required. Indicates the type of the service area business.
+          "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+            "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+              { # Defines an area that's represented by a place ID.
+                "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+                "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+              },
+            ],
+          },
+          "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+        },
+        "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+          { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+            "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+              "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+              "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+                "description": "A String", # Optional. Description of the price list, section, or item.
+                "displayName": "A String", # Required. Display name for the price list, section, or item.
+                "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+              },
+            },
+            "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+              "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.
+            },
+            "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+              "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+              "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+            },
+          },
+        ],
+        "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+          "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+            { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+              "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+              "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+              },
+              "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+                "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+                "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+                "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+                "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+                "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+                "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+              },
+            },
+          ],
+        },
+        "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+        "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+          "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+            "A String",
+          ],
+          "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+          "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+          "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+          "organization": "A String", # Optional. The name of the organization at the address.
+          "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+          "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+            "A String",
+          ],
+          "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+          "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+          "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+          "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+        },
+        "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+        "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+      },
+      "name": "A String", # Resource name of this GoogleLocation, in the format `googleLocations/{googleLocationId}`.
+      "requestAdminRightsUri": "A String", # A URL that will redirect the user to the request admin rights UI. This field is only present if the location has already been claimed by any user, including the current user.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessbusinessinformation_v1alpha.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.html new file mode 100644 index 0000000000..b56130d6e1 --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.html @@ -0,0 +1,136 @@ + + + +

My Business Business Information API

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ attributes() +

+

Returns the attributes Resource.

+ +

+ categories() +

+

Returns the categories Resource.

+ +

+ chains() +

+

Returns the chains Resource.

+ +

+ googleLocations() +

+

Returns the googleLocations Resource.

+ +

+ locations() +

+

Returns the locations 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/mybusinessbusinessinformation_v1alpha.locations.attributes.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.locations.attributes.html new file mode 100644 index 0000000000..3ad70e5956 --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.locations.attributes.html @@ -0,0 +1,202 @@ + + + +

My Business Business Information API . locations . attributes

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getExtended(name, x__xgafv=None)

+

Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.

+

+ getGoogleUpdated(name, x__xgafv=None)

+

Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getExtended(name, x__xgafv=None) +
Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.
+
+Args:
+  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (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 AttributesService.GetExtendedAttributes.
+  "extendedAttributes": [ # Output only. The attributes with extended metadata.
+    { # Represents an attribute along with its edit metadata and current serving state.
+      "attributeProvidedByMerchant": { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes. # Output only. The underlying attribute data managed by the merchant.
+        "name": "A String", # Required. The resource name for this attribute.
+        "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+          "setValues": [ # Enum values that are set.
+            "A String",
+          ],
+          "unsetValues": [ # Enum values that are unset.
+            "A String",
+          ],
+        },
+        "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+          { # Values for an attribute with a `value_type` of URL.
+            "uri": "A String", # Required. The proposed URI value for this attribute.
+          },
+        ],
+        "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+        "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+          "",
+        ],
+      },
+      "attributeSeenByConsumers": { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes. # Output only. The attribute data currently visible to consumers on Google Maps and Search.
+        "name": "A String", # Required. The resource name for this attribute.
+        "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+          "setValues": [ # Enum values that are set.
+            "A String",
+          ],
+          "unsetValues": [ # Enum values that are unset.
+            "A String",
+          ],
+        },
+        "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+          { # Values for an attribute with a `value_type` of URL.
+            "uri": "A String", # Required. The proposed URI value for this attribute.
+          },
+        ],
+        "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+        "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+          "",
+        ],
+      },
+      "extendedFieldData": { # Represents detailed metadata for an edit on a specific field/attribute. # Output only. Detailed edit status and metadata for this specific attribute.
+        "lastEditLifecycleStage": "A String", # Output only. The current lifecycle stage of the merchant's most recent edit on this value.
+        "rejectionReason": "A String", # Output only. Reason for rejection, only populated if `last_edit_lifecycle_stage` is `EDIT_LIFECYCLE_STAGE_REJECTED`.
+        "source": "A String", # Output only. Origin source attribution of the most recent merchant edit. Not all edits will have a source specified.
+        "updateTime": "A String", # Output only. Timestamp of when the merchant's most recent edit was submitted.
+      },
+    },
+  ],
+  "name": "A String", # Output only. Google identifier for this location in the form of `locations/{location_id}/attributes`.
+}
+
+ +
+ getGoogleUpdated(name, x__xgafv=None) +
Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.
+
+Args:
+  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A container for all the attributes for a given location.
+  "attributes": [ # A collection of attributes that need to be updated.
+    { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.
+      "name": "A String", # Required. The resource name for this attribute.
+      "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+        "setValues": [ # Enum values that are set.
+          "A String",
+        ],
+        "unsetValues": [ # Enum values that are unset.
+          "A String",
+        ],
+      },
+      "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+        { # Values for an attribute with a `value_type` of URL.
+          "uri": "A String", # Required. The proposed URI value for this attribute.
+        },
+      ],
+      "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+      "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+        "",
+      ],
+    },
+  ],
+  "name": "A String", # Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessbusinessinformation_v1alpha.locations.html b/docs/dyn/mybusinessbusinessinformation_v1alpha.locations.html new file mode 100644 index 0000000000..a34aca9e7a --- /dev/null +++ b/docs/dyn/mybusinessbusinessinformation_v1alpha.locations.html @@ -0,0 +1,1678 @@ + + + +

My Business Business Information API . locations

+

Instance Methods

+

+ attributes() +

+

Returns the attributes Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ delete(name, x__xgafv=None)

+

Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.

+

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

+

Returns the specified location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.

+

+ getAttributes(name, x__xgafv=None)

+

Retrieves attributes for a location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.

+

+ getExtended(name, x__xgafv=None)

+

Returns the specified location with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes a mapping of field paths to metadata describing the current state of edits on that field, its origin source, and rejection details.

+

+ getGoogleUpdated(name, readMask=None, x__xgafv=None)

+

Returns the specified location as it appears live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version. The returned GoogleUpdatedLocation contains masks that indicate which fields differ from the merchant's information.

+

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

+

Updates the specified location.

+

+ updateAttributes(name, attributeMask=None, body=None, x__xgafv=None)

+

Update attributes for a given location.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.
+
+Args:
+  name: string, Required. The name of the location to delete. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, readMask=None, x__xgafv=None) +
Returns the specified location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.
+
+Args:
+  name: string, Required. The name of the location to fetch. (required)
+  readMask: string, Required. Read mask to specify what fields will be returned in the response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+  "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+    "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+  },
+  "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+    "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+      { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    ],
+    "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  },
+  "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+    "A String",
+  ],
+  "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+  "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+    "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+    "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+    "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+    "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+    "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+    "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+    "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+    "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+    "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+    "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+    "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+    "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+    "mapsUri": "A String", # Output only. A link to the location on Maps.
+    "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+    "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+  },
+  "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+    { # The time periods during which a location is open for certain types of business.
+      "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+      "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+  "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+    "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+    "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+  },
+  "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+    "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+      "A String",
+    ],
+    "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+  },
+  "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+    "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+  },
+  "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+    "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+      { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+        "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+    ],
+  },
+  "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+    "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+      { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    ],
+    "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+    "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+      "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+      "relationType": "A String", # Required. The type of the relationship.
+    },
+  },
+  "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+    "businessType": "A String", # Required. Indicates the type of the service area business.
+    "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+      "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+        { # Defines an area that's represented by a place ID.
+          "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+          "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+        },
+      ],
+    },
+    "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+  },
+  "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+    { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+      "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+        "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+        "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+          "description": "A String", # Optional. Description of the price list, section, or item.
+          "displayName": "A String", # Required. Display name for the price list, section, or item.
+          "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+        },
+      },
+      "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+        "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.
+      },
+      "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+        "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+        "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+      },
+    },
+  ],
+  "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+    "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+      { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+        "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+    ],
+  },
+  "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+  "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+  },
+  "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+  "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+}
+
+ +
+ getAttributes(name, x__xgafv=None) +
Retrieves attributes for a location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.
+
+Args:
+  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A container for all the attributes for a given location.
+  "attributes": [ # A collection of attributes that need to be updated.
+    { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.
+      "name": "A String", # Required. The resource name for this attribute.
+      "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+        "setValues": [ # Enum values that are set.
+          "A String",
+        ],
+        "unsetValues": [ # Enum values that are unset.
+          "A String",
+        ],
+      },
+      "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+        { # Values for an attribute with a `value_type` of URL.
+          "uri": "A String", # Required. The proposed URI value for this attribute.
+        },
+      ],
+      "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+      "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+        "",
+      ],
+    },
+  ],
+  "name": "A String", # Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
+}
+
+ +
+ getExtended(name, x__xgafv=None) +
Returns the specified location with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes a mapping of field paths to metadata describing the current state of edits on that field, its origin source, and rejection details.
+
+Args:
+  name: string, Required. The name of the location to fetch. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a location along with its edit metadata and current serving state.
+  "extendedFieldData": { # Output only. Extended field data, keyed by the name of a top-level field of the `Location` resource. Keys are always plain top-level field names, never nested field paths. Each top-level field is treated atomically, so if you change a subfield, this map will treat it as a change to the top-level field.
+    "a_key": { # Represents detailed metadata for an edit on a specific field/attribute.
+      "lastEditLifecycleStage": "A String", # Output only. The current lifecycle stage of the merchant's most recent edit on this value.
+      "rejectionReason": "A String", # Output only. Reason for rejection, only populated if `last_edit_lifecycle_stage` is `EDIT_LIFECYCLE_STAGE_REJECTED`.
+      "source": "A String", # Output only. Origin source attribution of the most recent merchant edit. Not all edits will have a source specified.
+      "updateTime": "A String", # Output only. Timestamp of when the merchant's most recent edit was submitted.
+    },
+  },
+  "locationProvidedByMerchant": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # Output only. The underlying location data managed by the merchant.
+    "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+      "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+    },
+    "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+      "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+        { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+          "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+          "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+            { # More hours types that a business can offers, in addition to its regular hours.
+              "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+              "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+              "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+            },
+          ],
+          "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+          "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+            { # A message describing a service type that the business offers.
+              "displayName": "A String", # Output only. The human-readable display name for the service type.
+              "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+            },
+          ],
+        },
+      ],
+      "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    },
+    "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+      "A String",
+    ],
+    "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+    "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+      "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+      "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+      "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+      "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+      "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+      "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+      "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+      "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+      "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+      "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+      "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+      "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+      "mapsUri": "A String", # Output only. A link to the location on Maps.
+      "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+      "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+    },
+    "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+      { # The time periods during which a location is open for certain types of business.
+        "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+        "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+          { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+            "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+      },
+    ],
+    "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+    "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+      "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+      "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+    },
+    "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+      "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+        "A String",
+      ],
+      "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+    },
+    "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+      "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+    },
+    "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+      "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+    "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+      "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+        { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+          "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+          "relationType": "A String", # Required. The type of the relationship.
+        },
+      ],
+      "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+      "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    },
+    "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+      "businessType": "A String", # Required. Indicates the type of the service area business.
+      "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+        "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+          { # Defines an area that's represented by a place ID.
+            "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+            "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+          },
+        ],
+      },
+      "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+    },
+    "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+      { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+        "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+          "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+          "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+            "description": "A String", # Optional. Description of the price list, section, or item.
+            "displayName": "A String", # Required. Display name for the price list, section, or item.
+            "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+          },
+        },
+        "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+          "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.
+        },
+        "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+          "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+          "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+        },
+      },
+    ],
+    "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+      "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+        { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+          "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+        },
+      ],
+    },
+    "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+    "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+      "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "A String",
+      ],
+      "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+      "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+      "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+      "organization": "A String", # Optional. The name of the organization at the address.
+      "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+      "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+        "A String",
+      ],
+      "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+      "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+      "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+      "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+    },
+    "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+    "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+  },
+  "locationSeenByConsumers": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # Output only. The location data currently visible to consumers on Google Maps and Search.
+    "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+      "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+    },
+    "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+      "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+        { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+          "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+          "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+            { # More hours types that a business can offers, in addition to its regular hours.
+              "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+              "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+              "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+            },
+          ],
+          "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+          "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+            { # A message describing a service type that the business offers.
+              "displayName": "A String", # Output only. The human-readable display name for the service type.
+              "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+            },
+          ],
+        },
+      ],
+      "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    },
+    "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+      "A String",
+    ],
+    "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+    "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+      "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+      "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+      "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+      "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+      "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+      "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+      "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+      "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+      "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+      "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+      "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+      "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+      "mapsUri": "A String", # Output only. A link to the location on Maps.
+      "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+      "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+    },
+    "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+      { # The time periods during which a location is open for certain types of business.
+        "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+        "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+          { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+            "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+      },
+    ],
+    "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+    "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+      "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+      "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+    },
+    "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+      "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+        "A String",
+      ],
+      "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+    },
+    "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+      "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+    },
+    "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+      "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+    "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+      "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+        { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+          "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+          "relationType": "A String", # Required. The type of the relationship.
+        },
+      ],
+      "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+      "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    },
+    "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+      "businessType": "A String", # Required. Indicates the type of the service area business.
+      "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+        "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+          { # Defines an area that's represented by a place ID.
+            "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+            "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+          },
+        ],
+      },
+      "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+    },
+    "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+      { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+        "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+          "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+          "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+            "description": "A String", # Optional. Description of the price list, section, or item.
+            "displayName": "A String", # Required. Display name for the price list, section, or item.
+            "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+          },
+        },
+        "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+          "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.
+        },
+        "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+          "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+          "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+        },
+      },
+    ],
+    "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+      "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+        { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+          "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+        },
+      ],
+    },
+    "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+    "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+      "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "A String",
+      ],
+      "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+      "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+      "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+      "organization": "A String", # Optional. The name of the organization at the address.
+      "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+      "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+        "A String",
+      ],
+      "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+      "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+      "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+      "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+    },
+    "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+    "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+  },
+}
+
+ +
+ getGoogleUpdated(name, readMask=None, x__xgafv=None) +
Returns the specified location as it appears live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version. The returned GoogleUpdatedLocation contains masks that indicate which fields differ from the merchant's information.
+
+Args:
+  name: string, Required. The name of the location to fetch. (required)
+  readMask: string, Required. Read mask to specify what fields will be returned in the response.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents the view of a location as it appears to consumers, which includes updates that are currently serving on Google Maps and Search.
+  "diffMask": "A String", # The fields where the values in the view as it appears to consumers are different than the merchant's information. To accept these changes, patch the location. To reject, patch with your preferred values.
+  "location": { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories. # The Google-updated version of this location.
+    "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+      "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+    },
+    "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+      "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+        { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+          "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+          "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+            { # More hours types that a business can offers, in addition to its regular hours.
+              "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+              "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+              "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+            },
+          ],
+          "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+          "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+            { # A message describing a service type that the business offers.
+              "displayName": "A String", # Output only. The human-readable display name for the service type.
+              "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+            },
+          ],
+        },
+      ],
+      "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    },
+    "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+      "A String",
+    ],
+    "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+    "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+      "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+      "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+    },
+    "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+      "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+      "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+      "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+      "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+      "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+      "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+      "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+      "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+      "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+      "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+      "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+      "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+      "mapsUri": "A String", # Output only. A link to the location on Maps.
+      "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+      "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+    },
+    "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+      { # The time periods during which a location is open for certain types of business.
+        "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+        "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+          { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+            "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+            "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+            "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+              "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+              "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+              "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+      },
+    ],
+    "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+    "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+      "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+      "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+        "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+        "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+        "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+      },
+      "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+    },
+    "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+      "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+        "A String",
+      ],
+      "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+    },
+    "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+      "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+    },
+    "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+      "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+    "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+      "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+        { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+          "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+          "relationType": "A String", # Required. The type of the relationship.
+        },
+      ],
+      "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+      "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    },
+    "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+      "businessType": "A String", # Required. Indicates the type of the service area business.
+      "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+        "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+          { # Defines an area that's represented by a place ID.
+            "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+            "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+          },
+        ],
+      },
+      "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+    },
+    "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+      { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+        "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+          "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+          "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+            "description": "A String", # Optional. Description of the price list, section, or item.
+            "displayName": "A String", # Required. Display name for the price list, section, or item.
+            "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+          },
+        },
+        "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+          "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.
+        },
+        "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+          "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+          "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+        },
+      },
+    ],
+    "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+      "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+        { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+          "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+            "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+            "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+            "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+          },
+        },
+      ],
+    },
+    "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+    "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+      "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+        "A String",
+      ],
+      "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+      "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+      "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+      "organization": "A String", # Optional. The name of the organization at the address.
+      "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+      "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+        "A String",
+      ],
+      "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+      "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+      "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+      "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+    },
+    "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+    "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+  },
+  "pendingMask": "A String", # The fields where the merchant has provided an update that is currently in flight and hasn't yet been published to Maps and Search. This mask only tracks the status of the merchant's own edits, not external changes.
+}
+
+ +
+ patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) +
Updates the specified location.
+
+Args:
+  name: string, Identifier. Google identifier for this location in the form: `locations/{location_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+  "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+    "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+  },
+  "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+    "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+      { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    ],
+    "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  },
+  "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+    "A String",
+  ],
+  "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+  "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+    "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+    "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+    "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+    "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+    "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+    "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+    "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+    "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+    "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+    "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+    "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+    "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+    "mapsUri": "A String", # Output only. A link to the location on Maps.
+    "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+    "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+  },
+  "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+    { # The time periods during which a location is open for certain types of business.
+      "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+      "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+  "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+    "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+    "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+  },
+  "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+    "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+      "A String",
+    ],
+    "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+  },
+  "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+    "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+  },
+  "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+    "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+      { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+        "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+    ],
+  },
+  "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+    "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+      { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    ],
+    "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+    "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+      "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+      "relationType": "A String", # Required. The type of the relationship.
+    },
+  },
+  "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+    "businessType": "A String", # Required. Indicates the type of the service area business.
+    "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+      "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+        { # Defines an area that's represented by a place ID.
+          "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+          "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+        },
+      ],
+    },
+    "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+  },
+  "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+    { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+      "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+        "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+        "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+          "description": "A String", # Optional. Description of the price list, section, or item.
+          "displayName": "A String", # Required. Display name for the price list, section, or item.
+          "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+        },
+      },
+      "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+        "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.
+      },
+      "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+        "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+        "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+      },
+    },
+  ],
+  "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+    "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+      { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+        "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+    ],
+  },
+  "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+  "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+  },
+  "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+  "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+}
+
+  updateMask: string, Required. The specific fields to update.
+  validateOnly: boolean, Optional. If true, the request is validated without actually updating the location. When this field is set, we will only return validation errors if there were any. The response will be empty if no errors were found.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.
+  "adWordsLocationExtensions": { # Additional information that is surfaced in AdWords. # Optional. Additional information that is surfaced in AdWords.
+    "adPhone": "A String", # Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.
+  },
+  "categories": { # A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask. # Optional. The different categories that describe the business.
+    "additionalCategories": [ # Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.
+      { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.
+        "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+        "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+          { # More hours types that a business can offers, in addition to its regular hours.
+            "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+            "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+            "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+          },
+        ],
+        "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+        "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+          { # A message describing a service type that the business offers.
+            "displayName": "A String", # Output only. The human-readable display name for the service type.
+            "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+          },
+        ],
+      },
+    ],
+    "primaryCategory": { # A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`. # Required. Category that best describes the core business this location engages in.
+      "displayName": "A String", # Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.
+      "moreHoursTypes": [ # Output only. More hours types that are available for this business category.
+        { # More hours types that a business can offers, in addition to its regular hours.
+          "displayName": "A String", # Output only. The human-readable English display name for the hours type.
+          "hoursTypeId": "A String", # Output only. A stable ID provided by Google for this hours type.
+          "localizedDisplayName": "A String", # Output only. The human-readable localized display name for the hours type.
+        },
+      ],
+      "name": "A String", # Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).
+      "serviceTypes": [ # Output only. A list of all the service types that are available for this business category.
+        { # A message describing a service type that the business offers.
+          "displayName": "A String", # Output only. The human-readable display name for the service type.
+          "serviceTypeId": "A String", # Output only. A stable ID (provided by Google) for this service type.
+        },
+      ],
+    },
+  },
+  "labels": [ # Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.
+    "A String",
+  ],
+  "languageCode": "A String", # Immutable. The language of the location. Set during creation and not updateable.
+  "latlng": { # An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges. # Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients.
+    "latitude": 3.14, # The latitude in degrees. It must be in the range [-90.0, +90.0].
+    "longitude": 3.14, # The longitude in degrees. It must be in the range [-180.0, +180.0].
+  },
+  "metadata": { # Additional non-user-editable information about the location. # Output only. Additional non-user-editable information.
+    "canDelete": True or False, # Output only. Indicates whether the location can be deleted using the API.
+    "canHaveBusinessCalls": True or False, # Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.
+    "canHaveFoodMenus": True or False, # Output only. Indicates if the listing is eligible for food menu.
+    "canModifyServiceList": True or False, # Output only. Indicates if the listing can modify the service list.
+    "canOperateHealthData": True or False, # Output only. Indicates whether the location can operate on Health data.
+    "canOperateLocalPost": True or False, # Output only. Deprecated: This field is no longer populated and will be removed in a future version.
+    "canOperateLodgingData": True or False, # Output only. Indicates whether the location can operate on Lodging data.
+    "duplicateLocation": "A String", # Output only. The location resource that this location duplicates.
+    "hasGoogleUpdated": True or False, # Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.
+    "hasPendingEdits": True or False, # Output only. Indicates whether any of this Location's properties are in the edit pending state.
+    "hasVoiceOfMerchant": True or False, # Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.
+    "isParticularlyPersonalPlace": True or False, # Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).
+    "mapsUri": "A String", # Output only. A link to the location on Maps.
+    "newReviewUri": "A String", # Output only. A link to the page on Google Search where a customer can leave a review for the location.
+    "placeId": "A String", # Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.
+  },
+  "moreHours": [ # Optional. More hours for a business's different departments or specific customers.
+    { # The time periods during which a location is open for certain types of business.
+      "hoursTypeId": "A String", # Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.
+      "periods": [ # Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.
+        { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+          "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+          "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+          "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+            "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+            "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+            "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+    },
+  ],
+  "name": "A String", # Identifier. Google identifier for this location in the form: `locations/{location_id}`.
+  "openInfo": { # Information related to the opening state of the business. # Optional. A flag that indicates whether the location is currently open for business.
+    "canReopen": True or False, # Output only. Indicates whether this business is eligible for re-open.
+    "openingDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year 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 date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "status": "A String", # Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.
+  },
+  "phoneNumbers": { # A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as "+1 415 555 0132", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers). # Optional. The different phone numbers that customers can use to get in touch with the business.
+    "additionalPhones": [ # Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.
+      "A String",
+    ],
+    "primaryPhone": "A String", # Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.
+  },
+  "profile": { # All information pertaining to the location's profile. # Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns).
+    "description": "A String", # Required. Description of the location in your own voice, not editable by anyone else.
+  },
+  "regularHours": { # Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances. # Optional. Operating hours for the business.
+    "periods": [ # Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.
+      { # Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.
+        "closeDay": "A String", # Required. Indicates the day of the week this period ends on.
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "openDay": "A String", # Required. Indicates the day of the week this period starts on.
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+      },
+    ],
+  },
+  "relationshipData": { # Information of all parent and children locations related to this one. # Optional. All locations and chain related to this one.
+    "childrenLocations": [ # Optional. The list of children locations that this location has relations with.
+      { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.
+        "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+        "relationType": "A String", # Required. The type of the relationship.
+      },
+    ],
+    "parentChain": "A String", # Optional. The resource name of the Chain that this location is member of. How to find Chain ID
+    "parentLocation": { # Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location. # Optional. The parent location that this location has relations with.
+      "placeId": "A String", # Required. Specify the location that is on the other side of the relation by its placeID.
+      "relationType": "A String", # Required. The type of the relationship.
+    },
+  },
+  "serviceArea": { # Service area businesses provide their service at the customer's location (for example, a locksmith or plumber). # Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business.
+    "businessType": "A String", # Required. Indicates the type of the service area business.
+    "places": { # Defines the union of areas represented by a set of places. # Optional. The area that this business serves defined through a set of places.
+      "placeInfos": [ # Optional. The areas represented by place IDs. Limited to a maximum of 20 places.
+        { # Defines an area that's represented by a place ID.
+          "placeId": "A String", # Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)
+          "placeName": "A String", # Required. The localized name of the place. For example, `Scottsdale, AZ`.
+        },
+      ],
+    },
+    "regionCode": "A String", # Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.
+  },
+  "serviceItems": [ # Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.
+    { # A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.
+      "freeFormServiceItem": { # Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface. # Optional. This field will be set case of free-form services data.
+        "category": "A String", # Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.
+        "label": { # Label to be used when displaying the price list, section, or item. # Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id.
+          "description": "A String", # Optional. Description of the price list, section, or item.
+          "displayName": "A String", # Required. Display name for the price list, section, or item.
+          "languageCode": "A String", # Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.
+        },
+      },
+      "price": { # Represents an amount of money with its currency type. # Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item.
+        "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.
+      },
+      "structuredServiceItem": { # Represents a structured service offered by the merchant. For eg: toilet_installation. # Optional. This field will be set case of structured services data.
+        "description": "A String", # Optional. Description of structured service item. The character limit is 300.
+        "serviceTypeId": "A String", # Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.
+      },
+    },
+  ],
+  "specialHours": { # Represents a set of time periods when a location's operational hours differ from its normal business hours. # Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours.
+    "specialHourPeriods": [ # Required. A list of exceptions to the business's regular hours.
+      { # Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00
+        "closeTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "closed": True or False, # Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.
+        "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 calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `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.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+        "openTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false.
+          "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+          "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
+          "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
+          "seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
+        },
+        "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. The calendar date this special hour period starts on.
+          "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+          "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+          "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+        },
+      },
+    ],
+  },
+  "storeCode": "A String", # Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.
+  "storefrontAddress": { # Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478. # Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.
+  },
+  "title": "A String", # Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, "Chase ATM in Duane Reade").
+  "websiteUri": "A String", # Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.
+}
+
+ +
+ updateAttributes(name, attributeMask=None, body=None, x__xgafv=None) +
Update attributes for a given location.
+
+Args:
+  name: string, Required. Google identifier for this location in the form of `locations/{location_id}/attributes`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A container for all the attributes for a given location.
+  "attributes": [ # A collection of attributes that need to be updated.
+    { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.
+      "name": "A String", # Required. The resource name for this attribute.
+      "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+        "setValues": [ # Enum values that are set.
+          "A String",
+        ],
+        "unsetValues": [ # Enum values that are unset.
+          "A String",
+        ],
+      },
+      "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+        { # Values for an attribute with a `value_type` of URL.
+          "uri": "A String", # Required. The proposed URI value for this attribute.
+        },
+      ],
+      "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+      "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+        "",
+      ],
+    },
+  ],
+  "name": "A String", # Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
+}
+
+  attributeMask: string, Required. Attribute name of attributes that you'd like to update. Represented by `attributes/{attribute}`. Updates: All attributes provided in the attributes field that you would like to update must be set in the `attribute_mask`. Attributes set in the above list but not in the `attribute_mask` will be ignored. Deletes: If you'd like to delete certain attributes, they must be specified in the `attribute_mask` with no matching entry in the attributes list. If you'd like to delete all attributes set on a location, you should look up all the applicable attributes for the location and then add them to the `attribute_mask` with an empty attributes field.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A container for all the attributes for a given location.
+  "attributes": [ # A collection of attributes that need to be updated.
+    { # A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.
+      "name": "A String", # Required. The resource name for this attribute.
+      "repeatedEnumValue": { # Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified. # When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty.
+        "setValues": [ # Enum values that are set.
+          "A String",
+        ],
+        "unsetValues": [ # Enum values that are unset.
+          "A String",
+        ],
+      },
+      "uriValues": [ # When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.
+        { # Values for an attribute with a `value_type` of URL.
+          "uri": "A String", # Required. The proposed URI value for this attribute.
+        },
+      ],
+      "valueType": "A String", # Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.
+      "values": [ # The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.
+        "",
+      ],
+    },
+  ],
+  "name": "A String", # Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/mybusinessplaceactions_v1.locations.placeActionLinks.html b/docs/dyn/mybusinessplaceactions_v1.locations.placeActionLinks.html index e26a4084a2..d14ca7e512 100644 --- a/docs/dyn/mybusinessplaceactions_v1.locations.placeActionLinks.html +++ b/docs/dyn/mybusinessplaceactions_v1.locations.placeActionLinks.html @@ -112,6 +112,7 @@

Method Details

{ # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. @@ -131,6 +132,7 @@

Method Details

{ # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. @@ -175,6 +177,7 @@

Method Details

{ # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. @@ -207,6 +210,7 @@

Method Details

"placeActionLinks": [ # The returned list of place action links. { # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. @@ -244,6 +248,7 @@

Method Details

{ # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. @@ -253,7 +258,7 @@

Method Details

"uri": "A String", # Required. The link uri. The same uri can be reused for different action types across different locations. However, only one place action link is allowed for each unique combination of (uri, place action type, location). } - updateMask: string, Required. The specific fields to update. The only editable fields are `uri`, `place_action_type` and `is_preferred`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error. + updateMask: string, Required. The specific fields to update. The only editable fields are `uri`, `place_action_type`, `is_preferred` and `is_disabled`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -264,6 +269,7 @@

Method Details

{ # Represents a place action link and its attributes. "createTime": "A String", # Output only. The time when the place action link was created. + "isDisabled": True or False, # Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it. "isEditable": True or False, # Output only. Indicates whether this link can be edited by the client. "isPreferred": True or False, # Optional. Whether this link is preferred by the merchant. Only one link can be marked as preferred per place action type at a location. If a future request marks a different link as preferred for the same place action type, then the current preferred link (if any exists) will lose its preference. "name": "A String", # Optional. The resource name, in the format `locations/{location_id}/placeActionLinks/{place_action_link_id}`. The name field will only be considered in UpdatePlaceActionLink and DeletePlaceActionLink requests for updating and deleting links respectively. However, it will be ignored in CreatePlaceActionLink request, where `place_action_link_id` will be assigned by the server on successful creation of a new link and returned as part of the response. diff --git a/docs/dyn/mybusinessverifications_v1.verificationTokens.html b/docs/dyn/mybusinessverifications_v1.verificationTokens.html index 5968aca03a..4798080e89 100644 --- a/docs/dyn/mybusinessverifications_v1.verificationTokens.html +++ b/docs/dyn/mybusinessverifications_v1.verificationTokens.html @@ -95,7 +95,7 @@

Method Details

The object takes the form of: { # Request message for Verifications.GenerateInstantVerificationToken. - "locationId": "A String", # The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Google My Business API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](/my-business/reference/rest/v4/accounts.locations) documentation for more information. + "locationId": "A String", # The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Business Information API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) documentation for more information. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 52e52bf40f..24d244fe90 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -188,12 +188,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -235,12 +235,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -252,33 +252,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -289,7 +289,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -301,32 +301,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -337,7 +337,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -346,11 +346,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -368,8 +368,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -385,7 +385,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -395,7 +395,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -413,13 +413,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -427,7 +427,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -438,7 +438,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -448,18 +448,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -469,7 +469,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -481,11 +481,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -495,15 +495,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -524,7 +524,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -533,7 +533,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -545,7 +545,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -565,26 +565,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -610,12 +610,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -627,33 +627,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -664,7 +664,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -676,32 +676,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -712,7 +712,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -721,11 +721,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -743,8 +743,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -760,7 +760,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -770,7 +770,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -788,13 +788,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -802,7 +802,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -813,7 +813,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -823,18 +823,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -844,7 +844,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -856,11 +856,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -870,15 +870,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -899,7 +899,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -908,7 +908,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -920,7 +920,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -940,26 +940,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -1147,12 +1147,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -1194,12 +1194,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -1211,33 +1211,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -1248,7 +1248,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -1260,32 +1260,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -1296,7 +1296,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -1305,11 +1305,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -1327,8 +1327,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -1344,7 +1344,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -1354,7 +1354,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -1372,13 +1372,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -1386,7 +1386,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -1397,7 +1397,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -1407,18 +1407,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -1428,7 +1428,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -1440,11 +1440,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -1454,15 +1454,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -1483,7 +1483,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -1492,7 +1492,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -1504,7 +1504,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -1524,26 +1524,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -1569,12 +1569,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -1586,33 +1586,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -1623,7 +1623,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -1635,32 +1635,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -1671,7 +1671,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -1680,11 +1680,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -1702,8 +1702,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -1719,7 +1719,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -1729,7 +1729,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -1747,13 +1747,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -1761,7 +1761,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -1772,7 +1772,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -1782,18 +1782,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -1803,7 +1803,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -1815,11 +1815,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -1829,15 +1829,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -1858,7 +1858,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -1867,7 +1867,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -1879,7 +1879,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -1899,26 +1899,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -2097,12 +2097,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -2144,12 +2144,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -2161,33 +2161,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -2198,7 +2198,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -2210,32 +2210,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -2246,7 +2246,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -2255,11 +2255,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -2277,8 +2277,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -2294,7 +2294,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -2304,7 +2304,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -2322,13 +2322,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -2336,7 +2336,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -2347,7 +2347,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -2357,18 +2357,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -2378,7 +2378,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -2390,11 +2390,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -2404,15 +2404,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -2433,7 +2433,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -2442,7 +2442,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -2454,7 +2454,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -2474,26 +2474,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -2519,12 +2519,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -2536,33 +2536,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -2573,7 +2573,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -2585,32 +2585,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -2621,7 +2621,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -2630,11 +2630,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -2652,8 +2652,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -2669,7 +2669,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -2679,7 +2679,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -2697,13 +2697,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -2711,7 +2711,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -2722,7 +2722,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -2732,18 +2732,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -2753,7 +2753,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -2765,11 +2765,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -2779,15 +2779,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -2808,7 +2808,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -2817,7 +2817,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -2829,7 +2829,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -2849,26 +2849,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -3006,12 +3006,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -3053,12 +3053,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -3070,33 +3070,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -3107,7 +3107,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -3119,32 +3119,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -3155,7 +3155,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -3164,11 +3164,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -3186,8 +3186,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -3203,7 +3203,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -3213,7 +3213,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -3231,13 +3231,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -3245,7 +3245,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -3256,7 +3256,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -3266,18 +3266,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -3287,7 +3287,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -3299,11 +3299,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -3313,15 +3313,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -3342,7 +3342,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -3351,7 +3351,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -3363,7 +3363,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -3383,26 +3383,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -3428,12 +3428,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -3445,33 +3445,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -3482,7 +3482,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -3494,32 +3494,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -3530,7 +3530,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy) "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -3539,11 +3539,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -3561,8 +3561,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -3578,7 +3578,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -3588,7 +3588,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -3606,13 +3606,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -3620,7 +3620,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -3631,7 +3631,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -3641,18 +3641,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -3662,7 +3662,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -3674,11 +3674,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -3688,15 +3688,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -3717,7 +3717,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -3726,7 +3726,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -3738,7 +3738,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -3758,26 +3758,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], diff --git a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html index 21c6a78004..00bc6f6ddd 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.networkMonitoringProviders.monitoringPoints.html @@ -107,11 +107,11 @@

Method Details

Args: parent: string, Required. Parent value for DownloadInstallScriptRequest. Format: projects/{project}/locations/{location}/networkMonitoringProviders/{network_monitoring_provider} (required) - cloudDeploymentType: string, Optional. The deployment type for Cloud Monitoring Points. + cloudDeploymentType: string, Optional. Specifies the deployment type for Cloud Monitoring Points. Supported values: `TERRAFORM` for `GCE_VM`; `BICEP` or `TERRAFORM` for `AZURE_VM`; and `CLOUD_FORMATION` or `TERRAFORM` for `AWS_EC2`. If unspecified, defaults to `TERRAFORM`, `BICEP`, and `CLOUD_FORMATION`, respectively. Leave it unspecified for other types. Allowed values CLOUD_DEPLOYMENT_TYPE_UNSPECIFIED - Default value. If unspecified, defaults to `TERRAFORM` for `GCE_VM`, `BICEP` for `AZURE_VM`, and `CLOUD_FORMATION` for `AWS_EC2`. - TERRAFORM - Deploys using Terraform. - CLOUD_FORMATION - Deploys using AWS Cloud Formation. Supported only for `AWS_EC2` deployments. + TERRAFORM - Deploys using Terraform. Supported only for `GCE_VM`, `AZURE_VM`, and `AWS_EC2` deployments. + CLOUD_FORMATION - Deploys using AWS CloudFormation. Supported only for `AWS_EC2` deployments. BICEP - Deploys using Azure Bicep. Supported only for `AZURE_VM` deployments. hostname: string, Required. The hostname of the MonitoringPoint, e.g. "test-vm" monitoringPointType: string, Required. The type of the monitoring point. diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 9afb769999..9093119a5a 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -188,12 +188,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -235,12 +235,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -252,33 +252,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -289,7 +289,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -301,32 +301,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -337,7 +337,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -346,11 +346,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -368,8 +368,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -385,7 +385,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -395,7 +395,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -413,13 +413,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -427,7 +427,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -438,7 +438,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -448,18 +448,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -469,7 +469,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -481,11 +481,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -495,15 +495,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -524,7 +524,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -533,7 +533,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -545,7 +545,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -565,26 +565,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -610,12 +610,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -627,33 +627,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -664,7 +664,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -676,32 +676,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -712,7 +712,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -721,11 +721,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -743,8 +743,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -760,7 +760,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -770,7 +770,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -788,13 +788,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -802,7 +802,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -813,7 +813,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -823,18 +823,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -844,7 +844,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -856,11 +856,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -870,15 +870,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -899,7 +899,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -908,7 +908,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -920,7 +920,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -940,26 +940,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -1147,12 +1147,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -1194,12 +1194,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -1211,33 +1211,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -1248,7 +1248,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -1260,32 +1260,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -1296,7 +1296,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -1305,11 +1305,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -1327,8 +1327,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -1344,7 +1344,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -1354,7 +1354,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -1372,13 +1372,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -1386,7 +1386,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -1397,7 +1397,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -1407,18 +1407,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -1428,7 +1428,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -1440,11 +1440,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -1454,15 +1454,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -1483,7 +1483,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -1492,7 +1492,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -1504,7 +1504,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -1524,26 +1524,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -1569,12 +1569,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -1586,33 +1586,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -1623,7 +1623,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -1635,32 +1635,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -1671,7 +1671,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -1680,11 +1680,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -1702,8 +1702,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -1719,7 +1719,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -1729,7 +1729,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -1747,13 +1747,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -1761,7 +1761,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -1772,7 +1772,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -1782,18 +1782,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -1803,7 +1803,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -1815,11 +1815,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -1829,15 +1829,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -1858,7 +1858,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -1867,7 +1867,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -1879,7 +1879,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -1899,26 +1899,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -2097,12 +2097,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -2144,12 +2144,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -2161,33 +2161,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -2198,7 +2198,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -2210,32 +2210,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -2246,7 +2246,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -2255,11 +2255,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -2277,8 +2277,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -2294,7 +2294,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -2304,7 +2304,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -2322,13 +2322,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -2336,7 +2336,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -2347,7 +2347,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -2357,18 +2357,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -2378,7 +2378,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -2390,11 +2390,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -2404,15 +2404,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -2433,7 +2433,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -2442,7 +2442,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -2454,7 +2454,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -2474,26 +2474,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -2519,12 +2519,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -2536,33 +2536,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -2573,7 +2573,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -2585,32 +2585,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -2621,7 +2621,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -2630,11 +2630,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -2652,8 +2652,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -2669,7 +2669,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -2679,7 +2679,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -2697,13 +2697,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -2711,7 +2711,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -2722,7 +2722,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -2732,18 +2732,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -2753,7 +2753,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -2765,11 +2765,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -2779,15 +2779,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -2808,7 +2808,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -2817,7 +2817,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -2829,7 +2829,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -2849,26 +2849,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -3006,12 +3006,12 @@

Method Details

], "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # The source and destination endpoints derived from the test input and used for active probing. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "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). # Details about an internal failure or the cancellation of active probing. @@ -3053,12 +3053,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -3070,33 +3070,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -3107,7 +3107,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -3119,32 +3119,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -3155,7 +3155,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -3164,11 +3164,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -3186,8 +3186,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -3203,7 +3203,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -3213,7 +3213,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -3231,13 +3231,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -3245,7 +3245,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -3256,7 +3256,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -3266,18 +3266,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -3287,7 +3287,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -3299,11 +3299,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -3313,15 +3313,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -3342,7 +3342,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -3351,7 +3351,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -3363,7 +3363,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -3383,26 +3383,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], @@ -3428,12 +3428,12 @@

Method Details

{ # Trace represents one simulated packet forwarding path. * Each trace contains multiple ordered steps. * Each step is in a particular state with associated configuration. * State is categorized as final or non-final states. * Each final state has a reason associated. * Each trace must end with a final state (the last step). ``` |---------------------Trace----------------------| Step1(State) Step2(State) --- StepN(State(final)) ``` "endpointInfo": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Derived from the source and destination endpoints definition specified by user request, and validated by the data plane model. If there are multiple traces starting from different source locations, then the endpoint_info may be different between traces. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "forwardTraceId": 42, # ID of trace. For forward traces, this ID is unique for each trace. For return traces, it matches ID of associated forward trace. A single forward trace can be associated with none, one or more than one return trace. @@ -3445,33 +3445,33 @@

Method Details

"projectsMissingPermission": [ # List of project IDs the user specified in the request but lacks access to. In this case, analysis is aborted with the PERMISSION_DENIED cause. "A String", ], - "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance) + "resourceUri": "A String", # URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance) }, "appEngineVersion": { # For display only. Metadata associated with an App Engine version. # Display information of an App Engine service version. "displayName": "A String", # Name of an App Engine version. "environment": "A String", # App Engine execution environment for a version. "runtime": "A String", # Runtime of the App Engine version. - "uri": "A String", # URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}` + "uri": "A String", # URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}` }, "causesDrop": True or False, # This is a step that leads to the final state Drop. "cloudFunction": { # For display only. Metadata associated with a Cloud Function. # Display information of a Cloud Function. "displayName": "A String", # Name of a Cloud Function. "location": "A String", # Location in which the Cloud Function is deployed. - "uri": "A String", # URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}` + "uri": "A String", # URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}` "versionId": "A String", # Latest successfully deployed version id of the Cloud Function. }, "cloudRunJob": { # For display only. Metadata associated with a Cloud Run job. # Display information of a Cloud Run job. "displayName": "A String", # Name of a Cloud Run job. "location": "A String", # Location in which this job is deployed. - "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}` + "uri": "A String", # URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}` }, "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`. + "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`. + "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}` + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project}/locations/{location}/workerPools/{worker_pool}` 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. @@ -3482,7 +3482,7 @@

Method Details

"uri": "A String", # URI of a Cloud SQL instance in format "projects/{project}/instances/{instance}" }, "datastreamPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a Datastream Private Connection. - "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "deliver": { # Details of the final state "deliver" and associated resource. # Display information of the final state "deliver" and reason. "googleServiceType": "A String", # Recognized type of a Google Service the packet is delivered to (if applicable). @@ -3494,32 +3494,32 @@

Method Details

}, "description": "A String", # A description of the step. Usually this is a summary of the state. "directVpcEgressConnection": { # For display only. Metadata associated with a serverless direct VPC egress connection. # Display information of a serverless direct VPC egress connection. - "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Region in which the Direct VPC egress is deployed. "selectedIpAddress": "A String", # Selected starting IP address, from the selected IP range. "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}` + "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "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}" + "uri": "A String", # URI of the Private Connection in format "projects/{project}/locations/{location}/privateConnections/{private_connection}" }, "drop": { # Details of the final state "drop" and associated resource. # Display information of the final state "drop" and reason. "cause": "A String", # Cause that the packet is dropped. "destinationGeolocationCode": "A String", # Geolocation (region code) of the destination IP address (if relevant). "destinationIp": "A String", # Destination IP address of the dropped packet (if relevant). "region": "A String", # Region of the dropped packet (if relevant). - "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route) + "resourceUri": "A String", # URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route) "sourceGeolocationCode": "A String", # Geolocation (region code) of the source IP address (if relevant). "sourceIp": "A String", # Source IP address of the dropped packet (if relevant). }, "endpoint": { # For display only. The specification of the endpoints for the test. EndpointInfo is derived from source and destination Endpoint and validated by the backend data plane model. # Display information of the source and destination under analysis. The endpoint information in an intermediate state may differ with the initial input, as it might be modified by state like NAT, or Connection Proxy. "destinationIp": "A String", # Destination IP address. - "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}` + "destinationNetworkUri": "A String", # URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}` "destinationPort": 42, # Destination port. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". "sourceAgentUri": "A String", # URI of the source telemetry agent this packet originates from. "sourceIp": "A String", # Source IP address. - "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}` + "sourceNetworkUri": "A String", # URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}` "sourcePort": 42, # Source port. Only valid when protocol is TCP or UDP. }, "firewall": { # For display only. Metadata associated with a VPC firewall rule, an implied VPC firewall rule, or a firewall policy rule. # Display information of a Compute Engine firewall rule. @@ -3530,7 +3530,7 @@

Method Details

"networkUri": "A String", # The URI of the VPC network that the firewall rule is associated with in format "projects/{project}/global/networks/{network}". This field is not applicable to hierarchical firewall policy rules. "policy": "A String", # The name of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. "policyPriority": 42, # The priority of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. - "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy) + "policyUri": "A String", # The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` "priority": 42, # The priority of the firewall rule. "targetServiceAccounts": [ # The target service accounts specified by the firewall rule. "A String", @@ -3539,11 +3539,11 @@

Method Details

"A String", ], "targetType": "A String", # Target type of the firewall rule. - "uri": "A String", # The URI of the firewall rule in format "projects/{project}/global/firewalls/{firewall}". This field is not applicable to implied VPC firewall rules. + "uri": "A String", # The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules. }, "forward": { # Details of the final state "forward" and associated resource. # Display information of the final state "forward" and reason. "ipAddress": "A String", # IP address of the target (if applicable). - "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway) + "resourceUri": "A String", # URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway) "target": "A String", # Target type where this packet is forwarded to. }, "forwardingRule": { # For display only. Metadata associated with a Compute Engine forwarding rule. # Display information of a Compute Engine forwarding rule. @@ -3561,8 +3561,8 @@

Method Details

"vip": "A String", # VIP of the forwarding rule. }, "gkeMaster": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) cluster master. # Display information of a Google Kubernetes Engine cluster master. - "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}` - "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster) + "clusterNetworkUri": "A String", # URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}` + "clusterUri": "A String", # URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster) "dnsEndpoint": "A String", # DNS endpoint of a GKE cluster control plane. "externalIp": "A String", # External IP address of a GKE cluster control plane. "internalIp": "A String", # Internal IP address of a GKE cluster control plane. @@ -3578,7 +3578,7 @@

Method Details

}, "gkePod": { # For display only. Metadata associated with a Google Kubernetes Engine (GKE) Pod. # Display information of a Google Kubernetes Engine Pod. "ipAddress": "A String", # IP address of a GKE Pod. If the Pod is dual-stack, this is the IP address relevant to the trace. - "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}` "podUri": "A String", # URI of a GKE Pod. For Pods in regional Clusters, the URI format is: `projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` For Pods in zonal Clusters, the URI format is: `projects/{project}/zones/{zone}/clusters/{cluster}/k8s/namespaces/{namespace}/pods/{pod}` }, "googleService": { # For display only. Details of a Google Service sending packets to a VPC network. Although the source IP might be a publicly routable address, some Google Services use special routes within Google production infrastructure to reach Compute Engine Instances. https://cloud.google.com/vpc/docs/routes#special_return_paths # Display information of a Google service @@ -3588,7 +3588,7 @@

Method Details

"hybridSubnet": { # For display only. Metadata associated with a hybrid subnet. # Display information of a hybrid subnet. "displayName": "A String", # Name of a hybrid subnet. "region": "A String", # Name of a Google Cloud region where the hybrid subnet is configured. - "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "uri": "A String", # URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "instance": { # For display only. Metadata associated with a Compute Engine instance. # Display information of a Compute Engine instance. "displayName": "A String", # Name of a Compute Engine instance. @@ -3606,13 +3606,13 @@

Method Details

"uri": "A String", # URI of a Compute Engine instance in format "projects/{project}/zones/{zone}/instances/{instance}" }, "interconnectAttachment": { # For display only. Metadata associated with an Interconnect attachment. # Display information of an interconnect attachment. - "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "cloudRouterUri": "A String", # URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}` "displayName": "A String", # Name of an Interconnect attachment. - "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}` + "interconnectUri": "A String", # URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}` "l2AttachmentMatchedIpAddress": "A String", # Appliance IP address that was matched for L2_DEDICATED attachments. "region": "A String", # Name of a Google Cloud region where the Interconnect attachment is configured. "type": "A String", # The type of interconnect attachment this is. - "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}` + "uri": "A String", # URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}` }, "ipMasqueradingSkipped": { # For display only. Contains information about why IP masquerading was skipped for the packet. # Display information of the reason why GKE Pod IP masquerading was skipped. "nonMasqueradeRange": "A String", # The matched non-masquerade IP range. Only set if reason is DESTINATION_IP_IN_CONFIGURED_NON_MASQUERADE_RANGE or DESTINATION_IP_IN_DEFAULT_NON_MASQUERADE_RANGE. @@ -3620,7 +3620,7 @@

Method Details

}, "loadBalancer": { # For display only. Metadata associated with a load balancer. # Display information of the load balancers. Deprecated in favor of the `load_balancer_backend_info` field, not used in new tests. "backendType": "A String", # Type of load balancer's backend configuration. - "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}` + "backendUri": "A String", # URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}` "backends": [ # Information for the loadbalancer backends. { # For display only. Metadata associated with a specific load balancer backend. "displayName": "A String", # Name of a Compute Engine instance or network endpoint. @@ -3631,7 +3631,7 @@

Method Details

"A String", ], "healthCheckFirewallState": "A String", # State of the health check firewall configuration. - "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "uri": "A String", # URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) }, ], "healthCheckUri": "A String", # URI of the health check for the load balancer. Deprecated and no longer populated as different load balancer backends might have different health checks. @@ -3641,18 +3641,18 @@

Method Details

"backendBucketUri": "A String", # URI of the backend bucket this backend targets (if applicable) in format "projects/{project}/global/backendBuckets/{backend_bucket}". "backendServiceUri": "A String", # URI of the backend service this backend belongs to (if applicable) in format "projects/{project}/regions/{region}/backendServices/{backend_service}" (regional) or "projects/{project}/global/backendServices/{backend_service}" (global). "healthCheckFirewallsConfigState": "A String", # Output only. Health check firewalls configuration state for the backend. This is a result of the static firewall analysis (verifying that health check traffic from required IP ranges to the backend is allowed or not). The backend might still be unhealthy even if these firewalls are configured. Please refer to the documentation for more information: https://cloud.google.com/load-balancing/docs/firewall-rules - "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy) + "healthCheckUri": "A String", # URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy) "instanceGroupUri": "A String", # URI of the instance group this backend belongs to (if applicable) in format "projects/{project}/zones/{zone}/instanceGroups/{instance_group}". "instanceUri": "A String", # URI of the backend instance (if applicable) in format "projects/{project}/zones/{zone}/instances/{instance}". Populated for instance group backends, and zonal NEG backends. "name": "A String", # Display name of the backend. For example, it might be an instance name for the instance group backends, or an IP address and port for zonal network endpoint group backends. - "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG) + "networkEndpointGroupUri": "A String", # URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG) "pscGoogleApiTarget": "A String", # PSC Google API target this PSC NEG backend targets (if applicable). "pscServiceAttachmentUri": "A String", # URI of the PSC service attachment this PSC NEG backend targets (if applicable) in format "projects/{project}/regions/{region}/serviceAttachments/{service_attachment}". }, "nat": { # For display only. Metadata associated with NAT. # Display information of a NAT. "cloudNatGatewayType": "A String", # Type of Cloud NAT gateway. Only valid when `type` is CLOUD_NAT. "natGatewayName": "A String", # The name of Cloud NAT Gateway. Only valid when type is CLOUD_NAT. - "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address after NAT translation. "newDestinationPort": 42, # Destination port after NAT translation. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address after NAT translation. @@ -3662,7 +3662,7 @@

Method Details

"oldSourceIp": "A String", # Source IP address before NAT translation. "oldSourcePort": 42, # Source port before NAT translation. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}` + "routerUri": "A String", # URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}` "ruleNumber": 42, # The number of the NAT rule that was matched. Only valid when `type` is CLOUD_NAT. "type": "A String", # Type of NAT. }, @@ -3674,11 +3674,11 @@

Method Details

"uri": "A String", # URI of a Compute Engine network in format "projects/{project}/global/networks/{network}" }, "ngfwPacketInspection": { # For display only. Metadata associated with a layer 7 packet inspection by the firewall. # Display information of a layer 7 packet inspection by the firewall. - "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}` + "securityProfileGroupUri": "A String", # URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}` }, "projectId": "A String", # Project ID that contains the configuration this step is validating. "proxyConnection": { # For display only. Metadata associated with ProxyConnection. # Display information of a ProxyConnection. - "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}` "newDestinationIp": "A String", # Destination IP address of a new connection. "newDestinationPort": 42, # Destination port of a new connection. Only valid when protocol is TCP or UDP. "newSourceIp": "A String", # Source IP address of a new connection. @@ -3688,15 +3688,15 @@

Method Details

"oldSourceIp": "A String", # Source IP address of an original connection. "oldSourcePort": 42, # Source port of an original connection. Only valid when protocol is TCP or UDP. "protocol": "A String", # IP protocol in string format, for example: "TCP", "UDP", "ICMP". - "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` + "subnetUri": "A String", # URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}` }, "redisCluster": { # For display only. Metadata associated with a Redis Cluster. # Display information of a Redis Cluster. "discoveryEndpointIpAddress": "A String", # Discovery endpoint IP address of a Redis Cluster. "displayName": "A String", # Name of a Redis Cluster. "location": "A String", # Name of the region in which the Redis Cluster is defined. For example, "us-central1". - "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project_id}/global/networks/{network_id}". + "networkUri": "A String", # URI of the network containing the Redis Cluster endpoints in format "projects/{project}/global/networks/{network}". "secondaryEndpointIpAddress": "A String", # Secondary endpoint IP address of a Redis Cluster. - "uri": "A String", # URI of a Redis Cluster in format "projects/{project_id}/locations/{location}/clusters/{cluster_id}" + "uri": "A String", # URI of a Redis Cluster in format "projects/{project}/locations/{location}/clusters/{cluster}" }, "redisInstance": { # For display only. Metadata associated with a Cloud Redis Instance. # Display information of a Redis Instance. "displayName": "A String", # Name of a Cloud Redis Instance. @@ -3717,7 +3717,7 @@

Method Details

"instanceTags": [ # Instance tags of the route. "A String", ], - "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}` + "nccHubRouteUri": "A String", # For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}` "nccHubUri": "A String", # URI of the NCC Hub the route is advertised by in format "projects/{project}/locations/global/hubs/{hub}". PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "nccSpokeUri": "A String", # URI of the destination NCC Spoke in format "projects/{project}/locations/{location}/spokes/{spoke}" (regional) or "projects/{project}/locations/global/spokes/{spoke}" (global). PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub only. "networkUri": "A String", # URI of a VPC network where route is located in format "projects/{project}/global/networks/{network}". @@ -3726,7 +3726,7 @@

Method Details

"nextHopType": "A String", # Type of next hop. "nextHopUri": "A String", # URI of the next hop resource. "originatingRouteDisplayName": "A String", # For PEERING_SUBNET, PEERING_STATIC and PEERING_DYNAMIC routes, the name of the originating SUBNET/STATIC/DYNAMIC route. - "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}` + "originatingRouteUri": "A String", # For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}` "priority": 42, # Priority of the route. "protocols": [ # Protocols of the route. POLICY_BASED routes only. "A String", @@ -3738,7 +3738,7 @@

Method Details

"srcPortRanges": [ # Source port ranges of the route. POLICY_BASED routes only. "A String", ], - "uri": "A String", # URI of a route in format "projects/{project}/global/routes/{route}". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only. + "uri": "A String", # For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format "projects/{project}/global/routes/{route}". For POLICY_BASED routes URI of a route in format "projects/{project}/locations/{location}/policyBasedRoutes/{route}". Not set for other route types. }, "serverlessExternalConnection": { # For display only. Metadata associated with a serverless public connection. # Display information of a serverless public (external) connection. "selectedIpAddress": "A String", # Selected starting IP address, from the Google dynamic address pool. @@ -3758,26 +3758,26 @@

Method Details

"vpcConnector": { # For display only. Metadata associated with a VPC connector. # Display information of a VPC connector. "displayName": "A String", # Name of a VPC connector. "location": "A String", # Location in which the VPC connector is deployed. - "uri": "A String", # URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}` + "uri": "A String", # URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}` }, "vpnGateway": { # For display only. Metadata associated with a Compute Engine VPN gateway. # Display information of a Compute Engine VPN gateway. "displayName": "A String", # Name of a VPN gateway. "ipAddress": "A String", # IP address of the VPN gateway. - "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN gateway is configured. - "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) - "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) + "vpnTunnelUri": "A String", # URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, "vpnTunnel": { # For display only. Metadata associated with a Compute Engine VPN tunnel. # Display information of a Compute Engine VPN tunnel. "displayName": "A String", # Name of a VPN tunnel. - "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}` + "networkUri": "A String", # URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}` "region": "A String", # Name of a Google Cloud region where this VPN tunnel is configured. - "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway) + "remoteGateway": "A String", # URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway) "remoteGatewayIp": "A String", # Remote VPN gateway's IP address. "routingType": "A String", # Type of the routing policy. - "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway) + "sourceGateway": "A String", # URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway) "sourceGatewayIp": "A String", # Local VPN gateway's IP address. - "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}` + "uri": "A String", # URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}` }, }, ], diff --git a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html index cb77903e23..3518e5755f 100644 --- a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html @@ -129,7 +129,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -235,7 +235,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -281,7 +281,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -336,7 +336,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. diff --git a/docs/dyn/networkservices_v1.projects.locations.extensionBindings.html b/docs/dyn/networkservices_v1.projects.locations.extensionBindings.html index 44303363ee..8c0d9b17d5 100644 --- a/docs/dyn/networkservices_v1.projects.locations.extensionBindings.html +++ b/docs/dyn/networkservices_v1.projects.locations.extensionBindings.html @@ -114,7 +114,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -128,7 +128,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -136,42 +136,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -179,28 +179,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -212,7 +212,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -265,8 +265,8 @@

Method Details

Deletes the specified `ExtensionBinding` resource.
 
 Args:
-  name: string, Required. A name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
-  etag: string, Optional. The etag of the ExtensionBinding to delete.
+  name: string, Required. The name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
+  etag: string, Optional. The ETag of the `ExtensionBinding` to delete.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -301,7 +301,7 @@ 

Method Details

Gets details of the specified `ExtensionBinding` resource.
 
 Args:
-  name: string, Required. A name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
+  name: string, Required. The name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -314,7 +314,7 @@ 

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -328,7 +328,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -336,42 +336,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -379,28 +379,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -412,7 +412,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -438,7 +438,7 @@

Method Details

Args: parent: string, Required. The project and location from which the `ExtensionBinding` resources should be listed, specified in the format `projects/{project}/locations/{location}`. (required) pageSize: integer, Optional. Maximum number of `ExtensionBinding` resources to return per call. - pageToken: string, Optional. The value returned by the last `ListExtensionBindingsResponse` Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data. + pageToken: string, Optional. The value returned by the last `ListExtensionBindingsResponse`. Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -453,7 +453,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -467,7 +467,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -475,42 +475,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -518,28 +518,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -551,7 +551,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -603,7 +603,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -617,7 +617,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -625,42 +625,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -668,28 +668,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -701,7 +701,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -719,7 +719,7 @@

Method Details

"updateTime": "A String", # Output only. The timestamp when the resource was updated. } - updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask then all fields are overwritten. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html index e1be534aeb..63c17c005f 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbEdgeExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -132,7 +132,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -242,7 +242,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -259,7 +259,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -309,7 +309,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -326,7 +326,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -385,7 +385,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -402,7 +402,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html index b0f84e0615..a431468684 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbRouteExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -132,7 +132,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -245,7 +245,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -262,7 +262,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -315,7 +315,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -332,7 +332,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -394,7 +394,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -411,7 +411,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html index b0bb10214c..50bebec346 100644 --- a/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.lbTrafficExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -132,7 +132,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -245,7 +245,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -262,7 +262,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -315,7 +315,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -332,7 +332,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -394,7 +394,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. "failOpen": True or False, # Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE` or the default setting of `FALSE` is used, one of the following happens: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. @@ -411,7 +411,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1.projects.locations.multicastGroupConsumerActivations.html b/docs/dyn/networkservices_v1.projects.locations.multicastGroupConsumerActivations.html index e46159c416..fc87d8798c 100644 --- a/docs/dyn/networkservices_v1.projects.locations.multicastGroupConsumerActivations.html +++ b/docs/dyn/networkservices_v1.projects.locations.multicastGroupConsumerActivations.html @@ -120,7 +120,6 @@

Method Details

"enabled": True or False, # Optional. Whether to enable logging or not. }, "multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`. - "multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead. "multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupRangeActivations/*`. "name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. "resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. @@ -222,7 +221,6 @@

Method Details

"enabled": True or False, # Optional. Whether to enable logging or not. }, "multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`. - "multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead. "multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupRangeActivations/*`. "name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. "resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. @@ -264,7 +262,6 @@

Method Details

"enabled": True or False, # Optional. Whether to enable logging or not. }, "multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`. - "multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead. "multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupRangeActivations/*`. "name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. "resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. @@ -315,7 +312,6 @@

Method Details

"enabled": True or False, # Optional. Whether to enable logging or not. }, "multicastConsumerAssociation": "A String", # Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`. - "multicastGroup": "A String", # Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead. "multicastGroupRangeActivation": "A String", # Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupRangeActivations/*`. "name": "A String", # Identifier. The resource name of the multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupConsumerActivations/*`. "resourceState": "A String", # Output only. [Deprecated] The resource state of the multicast group consumer activation. Use the state field instead. diff --git a/docs/dyn/networkservices_v1.projects.locations.producerExtensions.html b/docs/dyn/networkservices_v1.projects.locations.producerExtensions.html index 3b15452ccb..69c27bf606 100644 --- a/docs/dyn/networkservices_v1.projects.locations.producerExtensions.html +++ b/docs/dyn/networkservices_v1.projects.locations.producerExtensions.html @@ -107,14 +107,14 @@

Method Details

body: object, The request body. The object takes the form of: -{ # `ProducerExtension` is a resource representing producer defined configuration for their service extension. +{ # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -123,11 +123,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. } - producerExtensionId: string, Required. Short name of the `ProducerExtension` resource to be created. + producerExtensionId: string, Required. The short name of the `ProducerExtension` resource to be created. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -162,8 +162,8 @@

Method Details

Deletes the specified `ProducerExtension` resource.
 
 Args:
-  name: string, Required. A name of the `ProducerExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
-  etag: string, Optional. The etag of the ProducerExtension to delete.
+  name: string, Required. The name of the `ProducerExtension` resource to delete. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
+  etag: string, Optional. The ETag of the `ProducerExtension` to delete.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -198,7 +198,7 @@ 

Method Details

Gets details of the specified `ProducerExtension` resource.
 
 Args:
-  name: string, Required. A name of the `ProducerExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
+  name: string, Required. The name of the `ProducerExtension` resource to get. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -207,14 +207,14 @@ 

Method Details

Returns: An object of the form: - { # `ProducerExtension` is a resource representing producer defined configuration for their service extension. + { # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -223,7 +223,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. }
@@ -233,9 +233,9 @@

Method Details

Lists `ProducerExtension` resources in a given project and location.
 
 Args:
-  parent: string, Required. The project and location from which the `ProducerExtension` resources should be listed, specified in the format `projects/{project}/locations/{location}`. (required)
+  parent: string, Required. The project and location from which the `ProducerExtension` resources should be listed, specified in this format: `projects/{project}/locations/{location}`. (required)
   pageSize: integer, Optional. Maximum number of `ProducerExtension` resources to return per call.
-  pageToken: string, Optional. The value returned by the last `ListProducerExtensionsResponse` Indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.
+  pageToken: string, Optional. The value returned by the last `ListProducerExtensionsResponse`. It indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -247,14 +247,14 @@ 

Method Details

{ # Response returned by the `ListProducerExtensions` method. "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. "producerExtensions": [ # List of `ProducerExtension` resources. - { # `ProducerExtension` is a resource representing producer defined configuration for their service extension. + { # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -263,7 +263,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. }, ], diff --git a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html index da9c2e2484..1f548da93d 100644 --- a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html +++ b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.html @@ -118,6 +118,8 @@

Method Details

{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. + "kmsKeyName": "A String", # Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek). + "kmsKeyVersion": "A String", # Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -222,7 +224,7 @@

Method Details

Args: name: string, Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required) - view: string, Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157). + view: string, Optional. Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157). Allowed values WASM_PLUGIN_VIEW_UNSPECIFIED - Unspecified value. Do not use. WASM_PLUGIN_VIEW_BASIC - If specified in the `GET` request for a `WasmPlugin` resource, the server's response includes just the `WasmPlugin` resource. @@ -238,6 +240,8 @@

Method Details

{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. + "kmsKeyName": "A String", # Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek). + "kmsKeyVersion": "A String", # Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -278,8 +282,8 @@

Method Details

Args: parent: string, Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`. (required) - pageSize: integer, Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - pageToken: string, The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned. + pageSize: integer, Optional. Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + pageToken: string, Optional. The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -297,6 +301,8 @@

Method Details

{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. + "kmsKeyName": "A String", # Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek). + "kmsKeyVersion": "A String", # Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -359,6 +365,8 @@

Method Details

{ # `WasmPlugin` is a resource representing a service executing a customer-provided Wasm module. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. + "kmsKeyName": "A String", # Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek). + "kmsKeyVersion": "A String", # Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information. "labels": { # Optional. Set of labels associated with the `WasmPlugin` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). "a_key": "A String", }, diff --git a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html index 083bd98021..01975a937b 100644 --- a/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html +++ b/docs/dyn/networkservices_v1.projects.locations.wasmPlugins.versions.html @@ -223,8 +223,8 @@

Method Details

Args: parent: string, Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required) - pageSize: integer, Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - pageToken: string, The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned. + pageSize: integer, Optional. Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + pageToken: string, Optional. The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html index 66678be3f4..b3fa4306a6 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html @@ -129,7 +129,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -235,7 +235,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -281,7 +281,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. @@ -336,7 +336,7 @@

Method Details

"a_key": "", # Properties of the object. }, "name": "A String", # Required. Identifier. Name of the `AuthzExtension` resource in the following format: `projects/{project}/locations/{location}/authzExtensions/{authz_extension}`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`. "timeout": "A String", # Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-10000 milliseconds. "updateTime": "A String", # Output only. The timestamp when the resource was updated. "wireFormat": "A String", # Optional. The format of communication supported by the callout extension. This field is supported only for regional `AuthzExtension` resources. If not specified, the default value `EXT_PROC_GRPC` is used. Global `AuthzExtension` resources use the `EXT_PROC_GRPC` wire format. diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.cdnEdgeExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.cdnEdgeExtensions.html index 3254834541..6768577504 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.cdnEdgeExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.cdnEdgeExtensions.html @@ -88,7 +88,7 @@

Instance Methods

Gets details of the specified `CdnEdgeExtension` resource.

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

-

Lists `CdnEdgeExtensions` resources in a given project and location.

+

Lists `CdnEdgeExtension` resources in a given project and location.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -110,12 +110,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). +{ # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -133,7 +133,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -150,8 +150,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `CdnEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. - "target": { # Specifies the set of targets to which `CdnEdgeExtension` should be applied to. # Required. Specifies the set of resources to which this extension should be applied to. - "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of [EdgeCacheService](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. + "target": { # Specifies the set of targets to which a `CdnEdgeExtension` will be applied. # Required. Specifies the set of resources to which this extension will be applied. + "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. "A String", ], }, @@ -159,7 +159,7 @@

Method Details

} cdnEdgeExtensionId: string, Required. User-provided ID of the `CdnEdgeExtension` resource to be created. - 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 can ignore the request if it has already been completed. The server guarantees that for 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 ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -195,7 +195,7 @@

Method Details

Args: name: string, Required. The name of the `CdnEdgeExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. (required) - requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`). x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -230,7 +230,7 @@

Method Details

Gets details of the specified `CdnEdgeExtension` resource.
 
 Args:
-  name: string, Required. A name of the `CdnEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. (required)
+  name: string, Required. The name of the `CdnEdgeExtension` resource to get. It must be in the `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}` format. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -239,12 +239,12 @@ 

Method Details

Returns: An object of the form: - { # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). + { # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -262,7 +262,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -279,8 +279,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `CdnEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. - "target": { # Specifies the set of targets to which `CdnEdgeExtension` should be applied to. # Required. Specifies the set of resources to which this extension should be applied to. - "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of [EdgeCacheService](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. + "target": { # Specifies the set of targets to which a `CdnEdgeExtension` will be applied. # Required. Specifies the set of resources to which this extension will be applied. + "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. "A String", ], }, @@ -290,12 +290,12 @@

Method Details

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists `CdnEdgeExtensions` resources in a given project and location.
+  
Lists `CdnEdgeExtension` resources in a given project and location.
 
 Args:
   parent: string, Required. The project and location from which the `CdnEdgeExtension` resources are listed. These values are specified in the following format: `projects/{project}/locations/{location}`. (required)
-  filter: string, Optional. Filtering results.
-  orderBy: string, Optional. Hint about how to order the results.
+  filter: string, Optional. Specifies a filter expression that restricts the resources listed in the response. The expression must be of the form ` `, where `` is a field name (in `snake_case` or `camelCase`) and `` is one of `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:` (the `HAS` operator). Multiple expressions can be combined using `AND`, `OR`, and `NOT`. For example, `extension_chains.name = "my-chain"` or `labels.env = "prod"`.
+  orderBy: string, Optional. Comma-separated list of fields by which you can sort the results.
   pageSize: integer, Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
   pageToken: string, Optional. A token identifying a page of results that the server returns.
   x__xgafv: string, V1 error format.
@@ -306,14 +306,14 @@ 

Method Details

Returns: An object of the form: - { # Message for response to listing `CdnEdgeExtension` resources. + { # Contains the response from listing `CdnEdgeExtension` resources. "cdnEdgeExtensions": [ # The list of `CdnEdgeExtension` resources. - { # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). + { # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -331,7 +331,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -348,8 +348,8 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `CdnEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. - "target": { # Specifies the set of targets to which `CdnEdgeExtension` should be applied to. # Required. Specifies the set of resources to which this extension should be applied to. - "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of [EdgeCacheService](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. + "target": { # Specifies the set of targets to which a `CdnEdgeExtension` will be applied. # Required. Specifies the set of resources to which this extension will be applied. + "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. "A String", ], }, @@ -386,12 +386,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). +{ # `CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices). "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -409,7 +409,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -426,15 +426,15 @@

Method Details

"a_key": "A String", }, "name": "A String", # Required. Identifier. Name of the `CdnEdgeExtension` resource in the following format: `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`. - "target": { # Specifies the set of targets to which `CdnEdgeExtension` should be applied to. # Required. Specifies the set of resources to which this extension should be applied to. - "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of [EdgeCacheService](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. + "target": { # Specifies the set of targets to which a `CdnEdgeExtension` will be applied. # Required. Specifies the set of resources to which this extension will be applied. + "resources": [ # Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`. "A String", ], }, "updateTime": "A String", # Output only. The timestamp when the resource was updated. } - requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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 ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + requestId: string, Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`). updateMask: string, Optional. Used to specify the fields to be overwritten in the `CdnEdgeExtension` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.extensionBindings.html b/docs/dyn/networkservices_v1beta1.projects.locations.extensionBindings.html index 7fcfebd259..bcb06947a5 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.extensionBindings.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.extensionBindings.html @@ -114,7 +114,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -128,7 +128,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -136,42 +136,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -179,28 +179,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -212,7 +212,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -265,8 +265,8 @@

Method Details

Deletes the specified `ExtensionBinding` resource.
 
 Args:
-  name: string, Required. A name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
-  etag: string, Optional. The etag of the ExtensionBinding to delete.
+  name: string, Required. The name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
+  etag: string, Optional. The ETag of the `ExtensionBinding` to delete.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -301,7 +301,7 @@ 

Method Details

Gets details of the specified `ExtensionBinding` resource.
 
 Args:
-  name: string, Required. A name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
+  name: string, Required. The name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -314,7 +314,7 @@ 

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -328,7 +328,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -336,42 +336,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -379,28 +379,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -412,7 +412,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -438,7 +438,7 @@

Method Details

Args: parent: string, Required. The project and location from which the `ExtensionBinding` resources should be listed, specified in the format `projects/{project}/locations/{location}`. (required) pageSize: integer, Optional. Maximum number of `ExtensionBinding` resources to return per call. - pageToken: string, Optional. The value returned by the last `ListExtensionBindingsResponse` Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data. + pageToken: string, Optional. The value returned by the last `ListExtensionBindingsResponse`. Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -453,7 +453,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -467,7 +467,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -475,42 +475,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -518,28 +518,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -551,7 +551,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -603,7 +603,7 @@

Method Details

"createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. "etag": "A String", # Optional. Etag of the resource. If provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. - "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored. + "failOpen": True or False, # Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored. "labels": { # Optional. Set of labels associated with the `ExtensionBinding` resource. The format must comply with [the following requirements](https://cloud.google.com/compute/docs/labeling-resources#requirements). "a_key": "A String", }, @@ -617,7 +617,7 @@

Method Details

"name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -625,42 +625,42 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], }, - "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified. + "notDestination": { # Describes properties of a single destination. # Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified. "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched. "headers": [ # Required. A list of HTTP headers to match against. If multiple header matches are provided, they are evaluated as an AND, meaning that all header matches must match for the request to match. Limited to 10 headers. { # Determines how an HTTP header should be matched. "name": "A String", # Required. Specifies the name of the header in the request. "value": { # Specifies matching logic for string values. # Optional. Specifies how the header match will be performed. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -668,28 +668,28 @@

Method Details

}, ], }, - "hosts": [ # Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. + "hosts": [ # Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method. + "paths": [ # Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. }, ], - "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources. + "resources": [ # Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources. { # Specifies matching logic for string values. "contains": "A String", # Optional. The input string must contain the substring specified here. An empty substring is not allowed. Examples: * `abc` matches the value `xyz.abc.def`. - "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`. + "exact": "A String", # Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`. "ignoreCase": True or False, # Optional. If true, the `exact`, `prefix`, `suffix`, or `contains` match is case insensitive. For example, the matcher `data` matches both `Data` and `data` when set to true. "prefix": "A String", # Optional. The input string must have the prefix specified here. An empty prefix is not allowed. Examples: * `abc` matches the value `abc.xyz`. "suffix": "A String", # Optional. The input string must have the suffix specified here. An empty suffix is not allowed. Examples: * `abc` matches the value `xyz.abc`. @@ -701,7 +701,7 @@

Method Details

], "name": "A String", # Identifier. Name of the `ExtensionBinding` resource in the following format: `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`. "priority": 42, # Optional. This field is not supported. - "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. + "producerExtension": "A String", # Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`. "producerMetadata": { # Optional. Additional metadata that should be passed to the attached extension with each request. This field is subject to the following limitations: * The total size of the metadata must be less than 1 KiB. * The total number of keys must be less than 16. * The length of each key must be less than 64 characters. * The length of each value must be less than 1024 characters. "a_key": "A String", }, @@ -719,7 +719,7 @@

Method Details

"updateTime": "A String", # Output only. The timestamp when the resource was updated. } - updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask then all fields are overwritten. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html index 46e221bf72..93cad32f2a 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbEdgeExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -133,7 +133,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -243,7 +243,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -261,7 +261,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -311,7 +311,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -329,7 +329,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -388,7 +388,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -406,7 +406,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html index a428fe6281..46ef88ebe6 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbRouteExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -133,7 +133,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -246,7 +246,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -264,7 +264,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -317,7 +317,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -335,7 +335,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -397,7 +397,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -415,7 +415,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html index 794bf3774f..d8821155ba 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTcpExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 1 extension chain per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -133,7 +133,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -243,7 +243,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 1 extension chain per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -261,7 +261,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -311,7 +311,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 1 extension chain per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -329,7 +329,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -388,7 +388,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 1 extension chain per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -406,7 +406,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html index 0a915c5d8c..a12f588a1b 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.lbTrafficExtensions.html @@ -115,7 +115,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -133,7 +133,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -246,7 +246,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -264,7 +264,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -317,7 +317,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -335,7 +335,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], @@ -397,7 +397,7 @@

Method Details

"description": "A String", # Optional. A human-readable description of the resource. "extensionChains": [ # Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. { # A single extension chain wrapper that contains the match conditions and extensions to execute. - "extensions": [ # Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain. + "extensions": [ # Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain. { # A single extension in the chain to execute for the matching request. "allowDynamicForwarding": True or False, # Optional. When set to `TRUE`, the response from an extension service is allowed to set the `com.google.envoy.dynamic_forwarding` namespace in the dynamic metadata. This field is not supported for plugin extensions or AuthzExtensions. Setting it results in a validation error. "authority": "A String", # Optional. The `:authority` header in the gRPC request sent from Envoy to the extension service. Required for Callout extensions. This field is not supported for plugin extensions. Setting it results in a validation error. @@ -415,7 +415,7 @@

Method Details

"observabilityMode": True or False, # Optional. When set to `true`, the calls to the extension backend are performed asynchronously, without pausing the processing of the ongoing request. In this mode, only `STREAMED` (default) body processing is supported. Responses, if any, are ignored. Supported by regional `LbTrafficExtension` and `LbRouteExtension` resources. "requestBodySendMode": "A String", # Optional. Configures the send mode for request body processing. The field can only be set if `supported_events` includes `REQUEST_BODY`. If `supported_events` includes `REQUEST_BODY`, but `request_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `REQUEST_BODY` and `REQUEST_TRAILERS`. This field can be set only for `LbTrafficExtension` and `LbRouteExtension` resources, and only when the `service` field of the extension points to a `BackendService`. Only `FULL_DUPLEX_STREAMED` mode is supported for `LbRouteExtension` resources. "responseBodySendMode": "A String", # Optional. Configures the send mode for response processing. If unspecified, the default value `STREAMED` is used. The field can only be set if `supported_events` includes `RESPONSE_BODY`. If `supported_events` includes `RESPONSE_BODY`, but `response_body_send_mode` is unset, the default value `STREAMED` is used. When this field is set to `FULL_DUPLEX_STREAMED`, `supported_events` must include both `RESPONSE_BODY` and `RESPONSE_TRAILERS`. This field can be set only for `LbTrafficExtension` resources, and only when the `service` field of the extension points to a `BackendService`. - "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources. + "service": "A String", # Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources. "supportedEvents": [ # Optional. A set of events during request or response processing for which this extension is called. For the `LbTrafficExtension` resource, this field is required. For the `LbRouteExtension` resource, this field is optional. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `LbEdgeExtension` resource, this field is required and must only contain `REQUEST_HEADERS` event. For the `AuthzExtension` resource, this field is optional. `REQUEST_HEADERS` is the only supported event. If unspecified, `REQUEST_HEADERS` event is assumed as supported. For the `CdnEdgeExtension` resource, this field is optional. Eligible values are `REQUEST_HEADERS` and `RESPONSE_HEADERS`. If unspecified, both are assumed as supported. "A String", ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.producerExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.producerExtensions.html index 6eb7fc5975..a1235bb75d 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.producerExtensions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.producerExtensions.html @@ -107,14 +107,14 @@

Method Details

body: object, The request body. The object takes the form of: -{ # `ProducerExtension` is a resource representing producer defined configuration for their service extension. +{ # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -123,11 +123,11 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. } - producerExtensionId: string, Required. Short name of the `ProducerExtension` resource to be created. + producerExtensionId: string, Required. The short name of the `ProducerExtension` resource to be created. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -162,8 +162,8 @@

Method Details

Deletes the specified `ProducerExtension` resource.
 
 Args:
-  name: string, Required. A name of the `ProducerExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
-  etag: string, Optional. The etag of the ProducerExtension to delete.
+  name: string, Required. The name of the `ProducerExtension` resource to delete. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
+  etag: string, Optional. The ETag of the `ProducerExtension` to delete.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -198,7 +198,7 @@ 

Method Details

Gets details of the specified `ProducerExtension` resource.
 
 Args:
-  name: string, Required. A name of the `ProducerExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
+  name: string, Required. The name of the `ProducerExtension` resource to get. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -207,14 +207,14 @@ 

Method Details

Returns: An object of the form: - { # `ProducerExtension` is a resource representing producer defined configuration for their service extension. + { # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -223,7 +223,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. }
@@ -233,9 +233,9 @@

Method Details

Lists `ProducerExtension` resources in a given project and location.
 
 Args:
-  parent: string, Required. The project and location from which the `ProducerExtension` resources should be listed, specified in the format `projects/{project}/locations/{location}`. (required)
+  parent: string, Required. The project and location from which the `ProducerExtension` resources should be listed, specified in this format: `projects/{project}/locations/{location}`. (required)
   pageSize: integer, Optional. Maximum number of `ProducerExtension` resources to return per call.
-  pageToken: string, Optional. The value returned by the last `ListProducerExtensionsResponse` Indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.
+  pageToken: string, Optional. The value returned by the last `ListProducerExtensionsResponse`. It indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -247,14 +247,14 @@ 

Method Details

{ # Response returned by the `ListProducerExtensions` method. "nextPageToken": "A String", # If there might be more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token`. "producerExtensions": [ # List of `ProducerExtension` resources. - { # `ProducerExtension` is a resource representing producer defined configuration for their service extension. + { # `ProducerExtension` is a resource that represents a producer-defined configuration for its service extension. "createTime": "A String", # Output only. The timestamp when the resource was created. "description": "A String", # Optional. A human-readable description of the resource. - "etag": "A String", # Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error. + "etag": "A String", # Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error. "extensionSettings": { # The configuration for the service that this `ProducerExtension` offers. # Required. The configuration for the service that this `ProducerExtension` offers. "authority": "A String", # Optional. The `:authority` header in the request sent to the extension service. "observabilityMode": True or False, # Optional. This field is not supported. - "service": "A String", # Required. URI of the PSC attachment. + "service": "A String", # Required. The URI of the Private Service Connect (PSC) attachment. "supportedEvents": [ # Required. The event types supported by the extension. "A String", ], @@ -263,7 +263,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # Identifier. Name of the `ProducerExtension` resource in the following format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`. - "phase": "A String", # Required. The phase in which this `ProducerExtension` should execute. + "phase": "A String", # Required. The phase in which this `ProducerExtension` runs. "updateTime": "A String", # Output only. The timestamp when the resource was updated. }, ], diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.telemetryPolicies.html b/docs/dyn/networkservices_v1beta1.projects.locations.telemetryPolicies.html index 70fc03bafd..063989d943 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.telemetryPolicies.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.telemetryPolicies.html @@ -121,6 +121,20 @@

Method Details

"labels": { # Optional. Set of label tags associated with the TelemetryPolicy resource. "a_key": "A String", }, + "loggingConfiguration": { # Configuration for logging collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how logging will be applied to the target resources. + "enable": True or False, # Optional. Indicates whether logging is enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. + "loggingHttpRequestHeaders": [ # Optional. The list of HTTP request headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "loggingHttpResponseHeaders": [ # Optional. The list of HTTP response headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "optionalFields": [ # Optional. Contains a list of optional fields to include in the logs. This field can only be specified if logging is enabled and `optional_mode` is set to `CUSTOM`. + "A String", + ], + "optionalMode": "A String", # Optional. Configures whether all, none, or a subset of optional fields should be added to the reported logs. This field can only be specified if logging is enabled. + "sampleRate": 3.14, # Optional. Specifies the logging sampling rate. The sampling rate is a float number in the interval [0, 1]. This field can only be specified if logging is enabled. + }, "metricsConfiguration": { # Configuration for metrics collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how metrics will be applied to the target resources. "enabled": True or False, # Optional. Indicates whether metrics are enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. }, @@ -240,6 +254,20 @@

Method Details

"labels": { # Optional. Set of label tags associated with the TelemetryPolicy resource. "a_key": "A String", }, + "loggingConfiguration": { # Configuration for logging collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how logging will be applied to the target resources. + "enable": True or False, # Optional. Indicates whether logging is enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. + "loggingHttpRequestHeaders": [ # Optional. The list of HTTP request headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "loggingHttpResponseHeaders": [ # Optional. The list of HTTP response headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "optionalFields": [ # Optional. Contains a list of optional fields to include in the logs. This field can only be specified if logging is enabled and `optional_mode` is set to `CUSTOM`. + "A String", + ], + "optionalMode": "A String", # Optional. Configures whether all, none, or a subset of optional fields should be added to the reported logs. This field can only be specified if logging is enabled. + "sampleRate": 3.14, # Optional. Specifies the logging sampling rate. The sampling rate is a float number in the interval [0, 1]. This field can only be specified if logging is enabled. + }, "metricsConfiguration": { # Configuration for metrics collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how metrics will be applied to the target resources. "enabled": True or False, # Optional. Indicates whether metrics are enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. }, @@ -299,6 +327,20 @@

Method Details

"labels": { # Optional. Set of label tags associated with the TelemetryPolicy resource. "a_key": "A String", }, + "loggingConfiguration": { # Configuration for logging collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how logging will be applied to the target resources. + "enable": True or False, # Optional. Indicates whether logging is enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. + "loggingHttpRequestHeaders": [ # Optional. The list of HTTP request headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "loggingHttpResponseHeaders": [ # Optional. The list of HTTP response headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "optionalFields": [ # Optional. Contains a list of optional fields to include in the logs. This field can only be specified if logging is enabled and `optional_mode` is set to `CUSTOM`. + "A String", + ], + "optionalMode": "A String", # Optional. Configures whether all, none, or a subset of optional fields should be added to the reported logs. This field can only be specified if logging is enabled. + "sampleRate": 3.14, # Optional. Specifies the logging sampling rate. The sampling rate is a float number in the interval [0, 1]. This field can only be specified if logging is enabled. + }, "metricsConfiguration": { # Configuration for metrics collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how metrics will be applied to the target resources. "enabled": True or False, # Optional. Indicates whether metrics are enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. }, @@ -367,6 +409,20 @@

Method Details

"labels": { # Optional. Set of label tags associated with the TelemetryPolicy resource. "a_key": "A String", }, + "loggingConfiguration": { # Configuration for logging collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how logging will be applied to the target resources. + "enable": True or False, # Optional. Indicates whether logging is enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. + "loggingHttpRequestHeaders": [ # Optional. The list of HTTP request headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "loggingHttpResponseHeaders": [ # Optional. The list of HTTP response headers to be logged. This field can only be specified if logging is enabled. + "A String", + ], + "optionalFields": [ # Optional. Contains a list of optional fields to include in the logs. This field can only be specified if logging is enabled and `optional_mode` is set to `CUSTOM`. + "A String", + ], + "optionalMode": "A String", # Optional. Configures whether all, none, or a subset of optional fields should be added to the reported logs. This field can only be specified if logging is enabled. + "sampleRate": 3.14, # Optional. Specifies the logging sampling rate. The sampling rate is a float number in the interval [0, 1]. This field can only be specified if logging is enabled. + }, "metricsConfiguration": { # Configuration for metrics collection. # Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how metrics will be applied to the target resources. "enabled": True or False, # Optional. Indicates whether metrics are enabled or disabled. Set to true to explicitly enable, or false to explicitly disable. }, diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html index 0ffd269bd3..5ad3976e31 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.html @@ -224,7 +224,7 @@

Method Details

Args: name: string, Required. A name of the `WasmPlugin` resource to get. Must be in the format `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required) - view: string, Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157). + view: string, Optional. Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157). Allowed values WASM_PLUGIN_VIEW_UNSPECIFIED - Unspecified value. Do not use. WASM_PLUGIN_VIEW_BASIC - If specified in the `GET` request for a `WasmPlugin` resource, the server's response includes just the `WasmPlugin` resource. @@ -282,8 +282,8 @@

Method Details

Args: parent: string, Required. The project and location from which the `WasmPlugin` resources are listed, specified in the following format: `projects/{project}/locations/global`. (required) - pageSize: integer, Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - pageToken: string, The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned. + pageSize: integer, Optional. Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + pageToken: string, Optional. The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html index dd6a7966ca..c308535216 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.wasmPlugins.versions.html @@ -223,8 +223,8 @@

Method Details

Args: parent: string, Required. The `WasmPlugin` resource whose `WasmPluginVersion`s are listed, specified in the following format: `projects/{project}/locations/global/wasmPlugins/{wasm_plugin}`. (required) - pageSize: integer, Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. - pageToken: string, The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned. + pageSize: integer, Optional. Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000. + pageToken: string, Optional. The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbDnsZones.html b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbDnsZones.html index 2f41dc0d05..26a313e1eb 100644 --- a/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbDnsZones.html +++ b/docs/dyn/oracledatabase_v1.projects.locations.odbNetworks.odbDnsZones.html @@ -92,6 +92,9 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Updates the `labels` of a single ODB DNS Zone.

Method Details

close() @@ -260,4 +263,54 @@

Method Details

+
+ patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None) +
Updates the `labels` of a single ODB DNS Zone.
+
+Args:
+  name: string, Identifier. The name of the OdbDnsZone resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbDnsZones/{odb_dns_zone} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents OdbDnsZone resource.
+  "createTime": "A String", # Output only. The date and time that the OdbDnsZone was created.
+  "domain": "A String", # Required. Immutable. The DNS suffix for the zone. Ex: abc.example.com.
+  "labels": { # Optional. Labels or tags associated with the resource.
+    "a_key": "A String",
+  },
+  "name": "A String", # Identifier. The name of the OdbDnsZone resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbDnsZones/{odb_dns_zone}
+  "state": "A String", # Output only. State of the OdbDnsZone.
+}
+
+  requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Optional. A mask specifying which fields in the OdbDnsZone should be updated. A field specified in the mask is updated. If a mask isn't provided, the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html index 2bb1a2f32a..6da4f255c8 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.html @@ -125,7 +125,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. @@ -309,7 +309,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. @@ -469,7 +469,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. diff --git a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html index 5c96fed983..77cc2fb2ef 100644 --- a/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html +++ b/docs/dyn/policysimulator_v1.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html @@ -111,7 +111,7 @@

Method Details

{ # OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # The custom constraint being violated. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. diff --git a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html index 189c0581ed..1a45c31f57 100644 --- a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html +++ b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.html @@ -128,7 +128,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. @@ -307,7 +307,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. @@ -490,7 +490,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. @@ -650,7 +650,7 @@

Method Details

{ # A change to an OrgPolicy custom constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # Optional. The new or updated custom constraint. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. diff --git a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html index a8efb22b9f..c154c8856c 100644 --- a/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html +++ b/docs/dyn/policysimulator_v1beta.organizations.locations.orgPolicyViolationsPreviews.orgPolicyViolations.html @@ -111,7 +111,7 @@

Method Details

{ # OrgPolicyViolation is a resource representing a single resource violating a single OrgPolicy constraint. "customConstraint": { # A custom constraint defined by customers which can *only* be applied to the given resource types and organization. By creating a custom constraint, customers can apply policies of this custom constraint. *Creating a custom constraint itself does NOT apply any policy enforcement*. # The custom constraint being violated. "actionType": "A String", # Allow or deny type. - "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. + "condition": "A String", # A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches("(production|test)_(.+_)?[\d]+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters. "description": "A String", # Detailed information about this custom policy constraint. The max length of the description is 2000 characters. "displayName": "A String", # One line display name for the UI. The max length of the display_name is 200 characters. "methodTypes": [ # All the operations being applied for this constraint. diff --git a/docs/dyn/realtimebidding_v1.bidders.creatives.html b/docs/dyn/realtimebidding_v1.bidders.creatives.html index 648bf86273..c5294bb968 100644 --- a/docs/dyn/realtimebidding_v1.bidders.creatives.html +++ b/docs/dyn/realtimebidding_v1.bidders.creatives.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

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

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

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.

list_next(previous_request, previous_response)

@@ -93,11 +93,17 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, adCategoryTaxonomyOverride=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
 
 Args:
   parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
+  adCategoryTaxonomyOverride: string, Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.
+    Allowed values
+      AD_CATEGORY_TAXONOMY_UNSPECIFIED - Default value that should never be used.
+      GOOGLE_AD_CATEGORY_TAXONOMY - Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data
+      IAB_CONTENT_1_0 - IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.
+      IAB_CONTENT_2_2 - IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details.
   filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
   pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
   pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
diff --git a/docs/dyn/realtimebidding_v1.buyers.creatives.html b/docs/dyn/realtimebidding_v1.buyers.creatives.html
index a86f395d44..a26c2a4bad 100644
--- a/docs/dyn/realtimebidding_v1.buyers.creatives.html
+++ b/docs/dyn/realtimebidding_v1.buyers.creatives.html
@@ -84,10 +84,10 @@ 

Instance Methods

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

Creates a creative.

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

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

Gets a creative.

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

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

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.

list_next(previous_request, previous_response)

@@ -1449,11 +1449,17 @@

Method Details

- get(name, view=None, x__xgafv=None) + get(name, adCategoryTaxonomyOverride=None, view=None, x__xgafv=None)
Gets a creative.
 
 Args:
   name: string, Required. Name of the creative to retrieve. See creative.name. (required)
+  adCategoryTaxonomyOverride: string, Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.
+    Allowed values
+      AD_CATEGORY_TAXONOMY_UNSPECIFIED - Default value that should never be used.
+      GOOGLE_AD_CATEGORY_TAXONOMY - Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data
+      IAB_CONTENT_1_0 - IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.
+      IAB_CONTENT_2_2 - IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details.
   view: string, Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
     Allowed values
       CREATIVE_VIEW_UNSPECIFIED - Not specified, equivalent to SERVING_DECISION_ONLY.
@@ -1904,11 +1910,17 @@ 

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) + list(parent, adCategoryTaxonomyOverride=None, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
 
 Args:
   parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
+  adCategoryTaxonomyOverride: string, Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.
+    Allowed values
+      AD_CATEGORY_TAXONOMY_UNSPECIFIED - Default value that should never be used.
+      GOOGLE_AD_CATEGORY_TAXONOMY - Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data
+      IAB_CONTENT_1_0 - IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.
+      IAB_CONTENT_2_2 - IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details.
   filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
   pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
   pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index c968d3cde2..d18c345c94 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -437,11 +437,8 @@ 

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -842,11 +839,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 494b701f66..7b702d62f9 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -408,11 +408,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -822,11 +819,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1197,11 +1191,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index d06c632f46..fca569c534 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -405,11 +405,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -752,11 +749,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1150,11 +1144,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1513,11 +1504,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1872,11 +1860,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2219,11 +2204,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2579,11 +2561,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2939,11 +2918,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index dd2ac4393a..fc152fc9db 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -444,11 +444,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -841,11 +838,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1289,11 +1283,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1702,11 +1693,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2111,11 +2099,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2508,11 +2493,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2919,11 +2901,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index b9e0059e21..c58c21ade4 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -451,11 +451,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -833,11 +830,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 8c8fa4dd49..09beba6d05 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -441,11 +441,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -854,11 +851,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1318,11 +1312,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1747,11 +1738,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2172,11 +2160,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2585,11 +2570,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 65a2d749aa..1727be4713 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -396,11 +396,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -774,11 +771,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index ff959d564d..be529d6eb5 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -448,11 +448,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -851,11 +848,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1302,11 +1296,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1717,11 +1708,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2132,11 +2120,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2535,11 +2520,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index fed46450dc..76a7b027a5 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -437,11 +437,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -842,11 +839,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 10bffa1cfd..831ffbd5fa 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -451,11 +451,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -833,11 +830,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index ce385bc2ff..aa94d5e957 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -450,11 +450,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -863,11 +860,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1327,11 +1321,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -1804,11 +1795,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2229,11 +2217,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. @@ -2642,11 +2627,8 @@

Method Details

}, }, "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{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`. For more information, see the [Kubernetes `emptyDir` volume documentation](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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. "nfs": { # Represents a persistent volume that will be mounted using NFS. This volume will be shared between all instances of the resource and data will not be deleted when the instance is shut down. diff --git a/docs/dyn/run_v2.projects.locations.instances.html b/docs/dyn/run_v2.projects.locations.instances.html index 76da166710..703ea6ba52 100644 --- a/docs/dyn/run_v2.projects.locations.instances.html +++ b/docs/dyn/run_v2.projects.locations.instances.html @@ -109,7 +109,7 @@

Instance Methods

Stops an Instance.

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

-

Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.

+

Returns permissions that a caller has on the specified Instance. There are no permissions required for making this API call.

Method Details

close() @@ -140,13 +140,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -170,12 +170,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -388,13 +400,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -408,12 +420,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -553,13 +562,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -583,12 +592,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -801,13 +822,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -821,12 +842,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -952,13 +970,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -982,12 +1000,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1200,13 +1230,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -1220,12 +1250,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1310,13 +1337,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -1340,12 +1367,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1558,13 +1597,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Instance, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -1578,12 +1617,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1831,7 +1867,7 @@

Method Details

testIamPermissions(resource, body=None, x__xgafv=None) -
Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.
+  
Returns permissions that a caller has on the specified Instance. There are no permissions required for making this API call.
 
 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)
diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.html b/docs/dyn/run_v2.projects.locations.jobs.executions.html
index 34450e7dc0..898c1e96dd 100644
--- a/docs/dyn/run_v2.projects.locations.jobs.executions.html
+++ b/docs/dyn/run_v2.projects.locations.jobs.executions.html
@@ -248,13 +248,13 @@ 

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations. @@ -291,12 +291,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -491,12 +503,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -579,13 +588,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations. @@ -622,12 +631,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -822,12 +843,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. diff --git a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html index 1dcdc47740..ecf773f20f 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html +++ b/docs/dyn/run_v2.projects.locations.jobs.executions.tasks.html @@ -115,13 +115,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containers": [ # Holds the single container that defines the unit of execution for this task. @@ -134,12 +134,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -368,12 +380,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -451,13 +460,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containers": [ # Holds the single container that defines the unit of execution for this task. @@ -470,12 +479,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -704,12 +725,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. diff --git a/docs/dyn/run_v2.projects.locations.jobs.html b/docs/dyn/run_v2.projects.locations.jobs.html index d62569981b..81f71aebed 100644 --- a/docs/dyn/run_v2.projects.locations.jobs.html +++ b/docs/dyn/run_v2.projects.locations.jobs.html @@ -142,13 +142,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -200,12 +200,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -400,12 +412,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -456,13 +465,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -565,13 +574,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -623,12 +632,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -823,12 +844,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -879,13 +897,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -974,13 +992,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1032,12 +1050,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1232,12 +1262,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1288,13 +1315,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. @@ -1342,13 +1369,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1400,12 +1427,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1600,12 +1639,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1656,13 +1692,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Job, containing its readiness status, and detailed error information in case it did not reach the desired state. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "uid": "A String", # Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. "updateTime": "A String", # Output only. The last-modified time. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index a6df1efbe9..744a9eeb23 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -152,13 +152,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -220,12 +220,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -437,12 +449,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -492,13 +501,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service. "traffic": [ # Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. @@ -636,13 +645,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -704,12 +713,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -921,12 +942,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -976,13 +994,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service. "traffic": [ # Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. @@ -1107,13 +1125,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1175,12 +1193,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1392,12 +1422,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1447,13 +1474,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service. "traffic": [ # Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. @@ -1538,13 +1565,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1606,12 +1633,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1823,12 +1862,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1878,13 +1914,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this Service, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. True if Cloud Run Threat Detection monitoring is enabled for the parent project of this Service. "traffic": [ # Optional. Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. diff --git a/docs/dyn/run_v2.projects.locations.services.revisions.html b/docs/dyn/run_v2.projects.locations.services.revisions.html index 00288f7545..0c07511793 100644 --- a/docs/dyn/run_v2.projects.locations.services.revisions.html +++ b/docs/dyn/run_v2.projects.locations.services.revisions.html @@ -199,13 +199,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -229,12 +229,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -462,12 +474,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -550,13 +559,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -580,12 +589,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -813,12 +834,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.html b/docs/dyn/run_v2.projects.locations.workerPools.html index ae51c331c1..401b356cd7 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.html @@ -139,13 +139,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -184,7 +184,13 @@

Method Details

"reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `instance_split_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `instance_splits` and `instance_split_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `instance_split_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings + "cpuScaling": { # Represents CPU-related scaling settings. # Optional. The CPU scaling settings for the worker pool. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. + }, "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode. + "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. + "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. + "scalingMode": "A String", # Optional. The scaling mode for the worker pool. }, "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. @@ -202,12 +208,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -408,12 +426,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -458,13 +473,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. @@ -568,13 +583,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -613,7 +628,13 @@

Method Details

"reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `instance_split_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `instance_splits` and `instance_split_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `instance_split_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings + "cpuScaling": { # Represents CPU-related scaling settings. # Optional. The CPU scaling settings for the worker pool. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. + }, "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode. + "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. + "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. + "scalingMode": "A String", # Optional. The scaling mode for the worker pool. }, "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. @@ -631,12 +652,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -837,12 +870,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -887,13 +917,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. @@ -984,13 +1014,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1029,7 +1059,13 @@

Method Details

"reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `instance_split_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `instance_splits` and `instance_split_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `instance_split_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings + "cpuScaling": { # Represents CPU-related scaling settings. # Optional. The CPU scaling settings for the worker pool. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. + }, "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode. + "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. + "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. + "scalingMode": "A String", # Optional. The scaling mode for the worker pool. }, "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. @@ -1047,12 +1083,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1253,12 +1301,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1303,13 +1348,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. @@ -1357,13 +1402,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "createTime": "A String", # Output only. The creation time. @@ -1402,7 +1447,13 @@

Method Details

"reconciling": True or False, # Output only. Returns true if the WorkerPool is currently being acted upon by the system to bring it into the desired state. When a new WorkerPool is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the WorkerPool to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `instance_split_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the WorkerPool, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `instance_splits` and `instance_split_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `instance_split_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created WorkerPools. Additional information on the failure can be found in `terminal_condition` and `conditions`. "satisfiesPzs": True or False, # Output only. Reserved for future use. "scaling": { # Worker pool scaling settings. # Optional. Specifies worker-pool-level scaling settings + "cpuScaling": { # Represents CPU-related scaling settings. # Optional. The CPU scaling settings for the worker pool. + "cpuUtilization": 3.14, # Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling. + }, "manualInstanceCount": 42, # Optional. The total number of instances in manual scaling mode. + "maxInstanceCount": 42, # Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages. + "minInstanceCount": 42, # Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages. + "scalingMode": "A String", # Optional. The scaling mode for the worker pool. }, "template": { # WorkerPoolRevisionTemplate describes the data a worker pool revision should have when created from a template. # Required. The template used to create revisions for this WorkerPool. "annotations": { # Optional. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system annotations in v1 now have a corresponding field in v2 WorkerPoolRevisionTemplate. This field follows Kubernetes annotations' namespacing, limits, and rules. @@ -1420,12 +1471,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -1626,12 +1689,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -1676,13 +1736,13 @@

Method Details

"terminalCondition": { # Defines a status condition for a resource. # Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, "threatDetectionEnabled": True or False, # Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. "uid": "A String", # Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. diff --git a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html index 73cd418070..5c08d9a6c2 100644 --- a/docs/dyn/run_v2.projects.locations.workerPools.revisions.html +++ b/docs/dyn/run_v2.projects.locations.workerPools.revisions.html @@ -160,13 +160,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -190,12 +190,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -423,12 +435,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. @@ -511,13 +520,13 @@

Method Details

{ # Defines a status condition for a resource. "executionReason": "A String", # Output only. A reason for the execution condition. "instanceReason": "A String", # Output only. A reason for the instance condition. - "lastTransitionTime": "A String", # Last time the condition transitioned from one status to another. - "message": "A String", # Human readable message indicating details about the current status. + "lastTransitionTime": "A String", # Output only. Last time the condition transitioned from one status to another. + "message": "A String", # Output only. Human readable message indicating details about the current status. "reason": "A String", # Output only. A common (service-level) reason for this condition. "revisionReason": "A String", # Output only. A reason for the revision condition. - "severity": "A String", # How to interpret failures of this condition, one of Error, Warning, Info - "state": "A String", # State of the condition. - "type": "A String", # type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. + "severity": "A String", # Output only. How to interpret failures of this condition, one of Error, Warning, Info + "state": "A String", # Output only. State of the condition. + "type": "A String", # Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * "Ready": True when the Resource is ready. }, ], "containerStatuses": [ # Output only. Status information for each of the specified containers. The status includes the resolved digest for specified images. @@ -541,12 +550,24 @@

Method Details

"buildpacksBuild": { # Buildpacks build configuration. # Optional. Builds the source using Buildpacks. "buildBaseImageUri": "A String", # Optional. Specify base image other than the default. "cacheImageUri": "A String", # Optional. Cache image URI. - "environmentVariables": { # Optional. Environment variables for the build. + "environmentVariables": { # Optional. Deprecated: Use environment_variables in BuildConfiguration instead. "a_key": "A String", }, }, "dockerBuild": { # Docker build configuration. # Optional. Builds the source using Docker. }, + "environmentVariables": [ # Optional. Environment variables for the build. + { # EnvVar represents an environment variable present in a Container. + "name": "A String", # Required. Name of the environment variable. Must not exceed 32768 characters. + "value": "A String", # Literal value of the environment variable. Defaults to "", and the maximum length is 32768 bytes. Variable references are not supported in Cloud Run. + "valueSource": { # EnvVarSource represents a source for the value of an EnvVar. # Source for the environment variable's value. + "secretKeyRef": { # SecretEnvVarSource represents a source for the value of an EnvVar. # Selects a secret and a specific version from Cloud Secret Manager. + "secret": "A String", # Required. The name of the secret in Cloud Secret Manager. Format: {secret_name} if the secret is in the same project. projects/{project}/secrets/{secret_name} if the secret is in a different project. + "version": "A String", # The Cloud Secret Manager secret version. Can be 'latest' for the latest version, an integer for a specific version, or a version alias. + }, + }, + }, + ], "imageRepositoryUri": "A String", # Required. Artifact Registry URI to store the built image. "serviceAccount": "A String", # Optional. The service account to use for the build. Its resource name in the format `projects/{project}/serviceAccounts/{email}`. "tags": [ # Optional. Tags to add to the build. @@ -774,12 +795,9 @@

Method Details

"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. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional - "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 - }, - "filestore": { # Represents a volume backed by a Filestore instance. # Optional. Represents a volume backed by a Filestore instance. - "volume": "A String", # Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}` + "emptyDir": { # Represents in-memory (tmpfs) 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. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time. + "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir). }, "gcs": { # Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk). # Persistent storage backed by a Google Cloud Storage bucket. "bucket": "A String", # Cloud Storage Bucket name. diff --git a/docs/dyn/searchconsole_v1.searchanalytics.html b/docs/dyn/searchconsole_v1.searchanalytics.html index 57d8f934f3..3c655390af 100644 --- a/docs/dyn/searchconsole_v1.searchanalytics.html +++ b/docs/dyn/searchconsole_v1.searchanalytics.html @@ -100,7 +100,15 @@

Method Details

"dataState": "A String", # The data state to be fetched, can be full or all, the latter including full and partial data. "dimensionFilterGroups": [ # [Optional] Zero or more filters to apply to the dimension grouping values; for example, 'query contains \"buy\"' to see only data where the query string contains the substring \"buy\" (not case-sensitive). You can filter by a dimension without grouping by it. { # A set of `dimension` value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together. - "filters": [ # Optional. A list of single-value filters in this group. + "filterLists": [ # Optional. Unlike the `filters` field which only supports a single value per entry, `filter_lists` allows matching against a list of values for a single dimension in one filter. `filter_lists` supports `COUNTRY` and `DEVICE` dimensions only. The maximum number of `expressions` allowed in a single filter list is 1000. + { # A filter that allows specifying multiple values for a single dimension. The matching logic is an implicit OR of equality matches (e.g., `COUNTRY` is `'usa'` OR `'can'`). Only supported for `COUNTRY` and `DEVICE`. + "dimension": "A String", # Required. The dimension to filter by. Only supported for `COUNTRY` and `DEVICE`. + "expressions": [ # Required. The values to filter against. A row matches if its value for the specified `dimension` equals any of these `expressions` (implicit OR logic between the `expressions`). The maximum number of `expressions` allowed is 1000. + "A String", + ], + }, + ], + "filters": [ # Optional. A list of single-value filters in this group. A list of multi-value dimension filters. A row matches if its value for the specified dimension matches any of the values in the filter list (implicit OR logic, e.g., `COUNTRY` is `'usa'` OR `'can'`). { # A filter test to be applied to each row in the data set, where a match can return the row. Filters are string comparisons, and values and dimension names are not case-sensitive. Individual filters are either AND'ed or OR'ed within their parent filter group, according to the group's group type. You do not need to group by a specified dimension to filter against it. "dimension": "A String", "expression": "A String", diff --git a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html index bad5c80b47..ec5c290b59 100644 --- a/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.securityHealthAnalyticsSettings.customModules.html @@ -1463,6 +1463,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html index 5a0691fe50..0753e865ef 100644 --- a/docs/dyn/securitycenter_v1.folders.sources.findings.html +++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html @@ -1032,6 +1032,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -2034,6 +2040,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -2892,6 +2904,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -3763,6 +3781,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -4635,6 +4659,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html index 312bdcb4f7..33bed67746 100644 --- a/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.securityHealthAnalyticsSettings.customModules.html @@ -1463,6 +1463,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html index c47c08b2f8..8e83188a69 100644 --- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html +++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html @@ -965,6 +965,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -1823,6 +1829,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -2752,6 +2764,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -3754,6 +3772,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -4612,6 +4636,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -5483,6 +5513,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -6355,6 +6391,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html index 9b85dce6f9..d6976950b1 100644 --- a/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.securityHealthAnalyticsSettings.customModules.html @@ -1463,6 +1463,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html index 38efe6b963..abafdca6c1 100644 --- a/docs/dyn/securitycenter_v1.projects.sources.findings.html +++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html @@ -1032,6 +1032,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -2034,6 +2040,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -2892,6 +2904,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -3763,6 +3781,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", @@ -4635,6 +4659,12 @@

Method Details

}, "providerRiskScore": "A String", "reachable": True or False, + "runtimeInfo": { + "evidence": "A String", + "firstObservedTime": "A String", + "impact": "A String", + "lastObservedTime": "A String", + }, "securityBulletin": { "bulletinId": "A String", "submissionTime": "A String", diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index ab998f6c95..ff16d0f510 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -485,7 +485,7 @@

Method Details

{ # Details about how and where to publish client libraries. "cppSettings": { # Settings for C++ client libraries. # Settings for C++ client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -499,7 +499,7 @@

Method Details

}, "dotnetSettings": { # Settings for Dotnet client libraries. # Settings for .NET client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -528,7 +528,7 @@

Method Details

}, "goSettings": { # Settings for Go client libraries. # Settings for Go client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -545,7 +545,7 @@

Method Details

}, "javaSettings": { # Settings for Java client libraries. # Settings for legacy Java features, supported in the Service YAML. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -564,7 +564,7 @@

Method Details

"launchStage": "A String", # Launch stage of this version of the API. "nodeSettings": { # Settings for Node client libraries. # Settings for Node client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -578,7 +578,7 @@

Method Details

}, "phpSettings": { # Settings for Php client libraries. # Settings for PHP client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -593,7 +593,7 @@

Method Details

}, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -613,7 +613,7 @@

Method Details

"restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. "rubySettings": { # Settings for Ruby client libraries. # Settings for Ruby client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1206,7 +1206,7 @@

Method Details

{ # Details about how and where to publish client libraries. "cppSettings": { # Settings for C++ client libraries. # Settings for C++ client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1220,7 +1220,7 @@

Method Details

}, "dotnetSettings": { # Settings for Dotnet client libraries. # Settings for .NET client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1249,7 +1249,7 @@

Method Details

}, "goSettings": { # Settings for Go client libraries. # Settings for Go client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1266,7 +1266,7 @@

Method Details

}, "javaSettings": { # Settings for Java client libraries. # Settings for legacy Java features, supported in the Service YAML. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1285,7 +1285,7 @@

Method Details

"launchStage": "A String", # Launch stage of this version of the API. "nodeSettings": { # Settings for Node client libraries. # Settings for Node client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1299,7 +1299,7 @@

Method Details

}, "phpSettings": { # Settings for Php client libraries. # Settings for PHP client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1314,7 +1314,7 @@

Method Details

}, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1334,7 +1334,7 @@

Method Details

"restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. "rubySettings": { # Settings for Ruby client libraries. # Settings for Ruby client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1939,7 +1939,7 @@

Method Details

{ # Details about how and where to publish client libraries. "cppSettings": { # Settings for C++ client libraries. # Settings for C++ client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1953,7 +1953,7 @@

Method Details

}, "dotnetSettings": { # Settings for Dotnet client libraries. # Settings for .NET client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1982,7 +1982,7 @@

Method Details

}, "goSettings": { # Settings for Go client libraries. # Settings for Go client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -1999,7 +1999,7 @@

Method Details

}, "javaSettings": { # Settings for Java client libraries. # Settings for legacy Java features, supported in the Service YAML. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2018,7 +2018,7 @@

Method Details

"launchStage": "A String", # Launch stage of this version of the API. "nodeSettings": { # Settings for Node client libraries. # Settings for Node client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2032,7 +2032,7 @@

Method Details

}, "phpSettings": { # Settings for Php client libraries. # Settings for PHP client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2047,7 +2047,7 @@

Method Details

}, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2067,7 +2067,7 @@

Method Details

"restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. "rubySettings": { # Settings for Ruby client libraries. # Settings for Ruby client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2672,7 +2672,7 @@

Method Details

{ # Details about how and where to publish client libraries. "cppSettings": { # Settings for C++ client libraries. # Settings for C++ client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2686,7 +2686,7 @@

Method Details

}, "dotnetSettings": { # Settings for Dotnet client libraries. # Settings for .NET client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2715,7 +2715,7 @@

Method Details

}, "goSettings": { # Settings for Go client libraries. # Settings for Go client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2732,7 +2732,7 @@

Method Details

}, "javaSettings": { # Settings for Java client libraries. # Settings for legacy Java features, supported in the Service YAML. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2751,7 +2751,7 @@

Method Details

"launchStage": "A String", # Launch stage of this version of the API. "nodeSettings": { # Settings for Node client libraries. # Settings for Node client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2765,7 +2765,7 @@

Method Details

}, "phpSettings": { # Settings for Php client libraries. # Settings for PHP client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2780,7 +2780,7 @@

Method Details

}, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -2800,7 +2800,7 @@

Method Details

"restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. "rubySettings": { # Settings for Ruby client libraries. # Settings for Ruby client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index 6d2d386f95..b513ef32bc 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -680,7 +680,7 @@

Method Details

{ # Details about how and where to publish client libraries. "cppSettings": { # Settings for C++ client libraries. # Settings for C++ client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -694,7 +694,7 @@

Method Details

}, "dotnetSettings": { # Settings for Dotnet client libraries. # Settings for .NET client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -723,7 +723,7 @@

Method Details

}, "goSettings": { # Settings for Go client libraries. # Settings for Go client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -740,7 +740,7 @@

Method Details

}, "javaSettings": { # Settings for Java client libraries. # Settings for legacy Java features, supported in the Service YAML. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -759,7 +759,7 @@

Method Details

"launchStage": "A String", # Launch stage of this version of the API. "nodeSettings": { # Settings for Node client libraries. # Settings for Node client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -773,7 +773,7 @@

Method Details

}, "phpSettings": { # Settings for Php client libraries. # Settings for PHP client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -788,7 +788,7 @@

Method Details

}, "pythonSettings": { # Settings for Python client libraries. # Settings for Python client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest @@ -808,7 +808,7 @@

Method Details

"restNumericEnums": True or False, # When using transport=rest, the client request will encode enums as numbers rather than strings. "rubySettings": { # Settings for Ruby client libraries. # Settings for Ruby client libraries. "common": { # Required information for every language. # Some settings. - "destinations": [ # The destination where API teams want this client library to be published. + "destinations": [ # Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published. "A String", ], "referenceDocsUri": "A String", # Link to automatically generated reference documentation. Example: https://cloud.google.com/nodejs/docs/reference/asset/latest diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html index adbe8595f2..bca24542c4 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html @@ -184,7 +184,6 @@

Method Details

"supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. "A String", ], - "trafficSource": "A String", # Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits. "unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], @@ -249,7 +248,6 @@

Method Details

"supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. "A String", ], - "trafficSource": "A String", # Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits. "unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], @@ -463,7 +461,6 @@

Method Details

"supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. "A String", ], - "trafficSource": "A String", # Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits. "unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], @@ -528,7 +525,6 @@

Method Details

"supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. "A String", ], - "trafficSource": "A String", # Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits. "unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }, ], diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html index 9290ecae69..81023c7104 100644 --- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html +++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html @@ -175,7 +175,6 @@

Method Details

"supportedLocations": [ # List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension. "A String", ], - "trafficSource": "A String", # Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits. "unit": "A String", # The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string. }
diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 221b0b3860..f767383f2d 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -386,7 +386,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -461,7 +461,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -521,7 +521,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -5824,7 +5824,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -5899,7 +5899,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -5959,7 +5959,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -8677,7 +8677,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -8752,7 +8752,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -8812,7 +8812,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -12630,7 +12630,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -12705,7 +12705,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -12765,7 +12765,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -16442,7 +16442,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -16517,7 +16517,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -16577,7 +16577,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -20247,7 +20247,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -20322,7 +20322,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -20382,7 +20382,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -24068,7 +24068,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -24143,7 +24143,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -24203,7 +24203,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. @@ -27920,7 +27920,7 @@

Method Details

"headerCount": 42, # The number of rows or columns in the data that are "headers". If not set, Google Sheets will guess how many rows are headers based on the data. (Note that BasicChartAxis.title may override the axis title inferred from the header values.) "interpolateNulls": True or False, # If some values in a series are missing, gaps may appear in the chart (e.g, segments of lines in a line chart will be missing). To eliminate these gaps set this to true. Applies to Line, Area, and Combo charts. "legendPosition": "A String", # The position of the chart legend. - "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts. + "lineSmoothing": True or False, # Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts. "series": [ # The data this chart is visualizing. { # A single series of data in a chart. For example, if charting stock prices over time, multiple series may exist, one for the "Open Price", "High Price", "Low Price" and "Close Price". "color": { # Represents a color in the RGBA color space. This representation is designed for simplicity of conversion to and from color representations in various languages over compactness. For example, the fields of this representation can be trivially provided to the constructor of `java.awt.Color` in Java; it can also be trivially provided to UIColor's `+colorWithRed:green:blue:alpha` method in iOS; and, with just a little work, it can be easily formatted into a CSS `rgba()` string in JavaScript. This reference page doesn't have information about the absolute color space that should be used to interpret the RGB value—for example, sRGB, Adobe RGB, DCI-P3, and BT.2020. By default, applications should assume the sRGB color space. When color equality needs to be decided, implementations, unless documented otherwise, treat two colors as equal if all their red, green, blue, and alpha values each differ by at most `1e-5`. Example (Java): import com.google.type.Color; // ... public static java.awt.Color fromProto(Color protocolor) { float alpha = protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue(), alpha); } public static Color toProto(java.awt.Color color) { float red = (float) color.getRed(); float green = (float) color.getGreen(); float blue = (float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) { result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / denominator) .build()); } return resultBuilder.build(); } // ... Example (iOS / Obj-C): // ... static UIColor* fromProto(Color* protocolor) { float red = [protocolor red]; float green = [protocolor green]; float blue = [protocolor blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if (alpha_wrapper != nil) { alpha = [alpha_wrapper value]; } return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; } static Color* toProto(UIColor* color) { CGFloat red, green, blue, alpha; if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) { return nil; } Color* result = [[Color alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue:blue]; if (alpha <= 0.9999) { [result setAlpha:floatWrapperWithValue(alpha)]; } [result autorelease]; return result; } // ... Example (JavaScript): // ... var protoToCssColor = function(rgb_color) { var redFrac = rgb_color.red || 0.0; var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) { return rgbToCssColor(red, green, blue); } var alphaFrac = rgb_color.alpha.value || 0.0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); }; var rgbToCssColor = function(red, green, blue) { var rgbNumber = new Number((red << 16) | (green << 8) | blue); var hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) { resultBuilder.push('0'); } resultBuilder.push(hexString); return resultBuilder.join(''); }; // ... # The color for elements (such as bars, lines, and points) associated with this series. If empty, a default color is used. Deprecated: Use color_style. @@ -27995,7 +27995,7 @@

Method Details

}, "type": "A String", # The type of the data label. }, - "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE. + "lineStyle": { # Properties that describe the style of a line. # The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE. "type": "A String", # The dash type of the line. "width": 42, # The thickness of the line, in px. }, @@ -28055,7 +28055,7 @@

Method Details

}, ], "targetAxis": "A String", # The minor axis that will specify the range of values for this series. For example, if charting stocks over time, the "Volume" series may want to be pinned to the right with the prices pinned to the left, because the scale of trading volume is different than the scale of prices. It is an error to specify an axis that isn't a valid minor axis for the chart's type. - "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported. + "type": "A String", # The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported. }, ], "stackedType": "A String", # The stacked type for charts that support vertical stacking. Applies to Area, Bar, Column, Combo, and Stepped Area charts. diff --git a/docs/dyn/storage_v1.anywhereCaches.html b/docs/dyn/storage_v1.anywhereCaches.html index ba8e90dd51..be897c5b12 100644 --- a/docs/dyn/storage_v1.anywhereCaches.html +++ b/docs/dyn/storage_v1.anywhereCaches.html @@ -92,12 +92,9 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

-

- pause(bucket, anywhereCacheId)

-

Pauses an Anywhere Cache instance.

resume(bucket, anywhereCacheId)

-

Resumes a paused or disabled Anywhere Cache instance.

+

Resumes a disabled Anywhere Cache instance.

update(bucket, anywhereCacheId, body=None)

Updates the config of an Anywhere Cache instance.

@@ -264,37 +261,9 @@

Method Details

-
- pause(bucket, anywhereCacheId) -
Pauses an Anywhere Cache instance.
-
-Args:
-  bucket: string, Name of the parent bucket. (required)
-  anywhereCacheId: string, The ID of requested Anywhere Cache instance. (required)
-
-Returns:
-  An object of the form:
-
-    { # An Anywhere Cache instance.
-  "admissionPolicy": "A String", # The cache-level entry admission policy.
-  "anywhereCacheId": "A String", # The ID of the Anywhere cache instance.
-  "bucket": "A String", # The name of the bucket containing this cache instance.
-  "createTime": "A String", # The creation time of the cache instance in RFC 3339 format.
-  "id": "A String", # The ID of the resource, including the project number, bucket name and anywhere cache ID.
-  "ingestOnWrite": True or False, # Specifies whether objects are ingested into the cache upon write.
-  "kind": "storage#anywhereCache", # The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.
-  "pendingUpdate": True or False, # True if the cache instance has an active Update long-running operation.
-  "selfLink": "A String", # The link to this cache instance.
-  "state": "A String", # The current state of the cache instance.
-  "ttl": "A String", # The TTL of all cache entries in whole seconds. e.g., "7200s".
-  "updateTime": "A String", # The modification time of the cache instance metadata in RFC 3339 format.
-  "zone": "A String", # The zone in which the cache instance is running. For example, us-central1-a.
-}
-
-
resume(bucket, anywhereCacheId) -
Resumes a paused or disabled Anywhere Cache instance.
+  
Resumes a disabled Anywhere Cache instance.
 
 Args:
   bucket: string, Name of the parent bucket. (required)
diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html
index 6d614348fc..0c6c6f898c 100644
--- a/docs/dyn/storage_v1.buckets.html
+++ b/docs/dyn/storage_v1.buckets.html
@@ -457,6 +457,9 @@ 

Method Details

"kind": "storage#storageLayout", # The kind of item this is. For storage layout, this is always storage#storageLayout. "location": "A String", # The location of the bucket. "locationType": "A String", # The type of the bucket location. + "rapidCacheInfo": { # The Rapid Cache configuration for the bucket. + "cacheType": "A String", # The type of cache in the bucket. Set to `rapid-cache` or `rapid-cache-ultra`, only if there is a cache present. + }, }
diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html index caad6b4376..76576a5084 100644 --- a/docs/dyn/storage_v1.objects.html +++ b/docs/dyn/storage_v1.objects.html @@ -286,6 +286,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }, "kind": "storage#composeRequest", # The kind of item this is. "sourceObjects": [ # The list of source objects that will be concatenated into a single object. @@ -408,6 +413,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -512,6 +522,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, } destinationKmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. @@ -630,6 +645,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -761,6 +781,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -942,6 +967,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, } contentEncoding: string, If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded. @@ -1059,6 +1089,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -1180,6 +1215,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }, ], "kind": "storage#objects", # The kind of item this is. For lists of objects, this is always storage#objects. @@ -1318,6 +1358,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -1420,6 +1465,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, } generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). @@ -1534,6 +1584,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -1649,6 +1704,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
@@ -1753,6 +1813,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, } destinationKmsKeyName: string, Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any. @@ -1881,6 +1946,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }, "rewriteToken": "A String", # A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy. "totalBytesRewritten": "A String", # The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response. @@ -2125,6 +2195,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, } generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default). @@ -2239,6 +2314,11 @@

Method Details

"timeFinalized": "A String", # The time when the object was finalized. "timeStorageClassUpdated": "A String", # The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. "updated": "A String", # The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. + "zonalAvailabilityInfo": { # Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache. + "availableZones": [ # A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a'). + "A String", + ], + }, }
diff --git a/docs/dyn/tasks_v1.tasks.html b/docs/dyn/tasks_v1.tasks.html index d70b4dfb87..702803d27e 100644 --- a/docs/dyn/tasks_v1.tasks.html +++ b/docs/dyn/tasks_v1.tasks.html @@ -371,7 +371,7 @@

Method Details

Args: tasklist: string, Task list identifier. (required) task: string, Task identifier. (required) - destinationTasklist: string, Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists. + destinationTasklist: string, Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. parent: string, Optional. New parent task identifier. If the task is moved to the top level, this parameter is omitted. The task set as parent must exist in the task list and can not be hidden. Exceptions: 1. Assigned and repeating tasks cannot be set as parent tasks (have subtasks), or be moved under a parent task (become subtasks). 2. Tasks that are both completed and hidden cannot be nested, so the parent field must be empty. previous: string, Optional. New previous sibling task identifier. If the task is moved to the first position among its siblings, this parameter is omitted. The task set as previous must exist in the task list and can not be hidden. Exceptions: 1. Tasks that are both completed and hidden can only be moved to position 0, so the previous field must be empty. x__xgafv: string, V1 error format. diff --git a/docs/dyn/walletobjects_v1.eventticketclass.html b/docs/dyn/walletobjects_v1.eventticketclass.html index c825a855ec..52e2d244dc 100644 --- a/docs/dyn/walletobjects_v1.eventticketclass.html +++ b/docs/dyn/walletobjects_v1.eventticketclass.html @@ -961,7 +961,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -988,7 +988,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2171,7 +2171,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2198,7 +2198,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3369,7 +3369,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3396,7 +3396,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4566,7 +4566,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4593,7 +4593,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5779,7 +5779,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5806,7 +5806,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6980,7 +6980,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -7007,7 +7007,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8177,7 +8177,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8204,7 +8204,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9376,7 +9376,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9403,7 +9403,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10573,7 +10573,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10600,7 +10600,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html index 4e3e932ff3..4e7ff07717 100644 --- a/docs/dyn/walletobjects_v1.eventticketobject.html +++ b/docs/dyn/walletobjects_v1.eventticketobject.html @@ -1287,7 +1287,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1314,7 +1314,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3318,7 +3318,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3345,7 +3345,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5337,7 +5337,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5364,7 +5364,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7355,7 +7355,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -7382,7 +7382,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9389,7 +9389,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9416,7 +9416,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -11430,7 +11430,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -11457,7 +11457,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -13450,7 +13450,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -13477,7 +13477,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -15468,7 +15468,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -15495,7 +15495,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -17488,7 +17488,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -17515,7 +17515,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -19506,7 +19506,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -19533,7 +19533,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html index c688eb4543..2368f24b9c 100644 --- a/docs/dyn/walletobjects_v1.flightclass.html +++ b/docs/dyn/walletobjects_v1.flightclass.html @@ -1132,7 +1132,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -1166,7 +1166,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2429,7 +2429,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -2463,7 +2463,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3714,7 +3714,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -3748,7 +3748,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4998,7 +4998,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -5032,7 +5032,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6298,7 +6298,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -6332,7 +6332,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7586,7 +7586,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -7620,7 +7620,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8870,7 +8870,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -8904,7 +8904,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10156,7 +10156,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -10190,7 +10190,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -11440,7 +11440,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -11474,7 +11474,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html index a7a37fd16c..2f2d797f4e 100644 --- a/docs/dyn/walletobjects_v1.flightobject.html +++ b/docs/dyn/walletobjects_v1.flightobject.html @@ -1517,7 +1517,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -1551,7 +1551,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3668,7 +3668,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -3702,7 +3702,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5807,7 +5807,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -5841,7 +5841,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7945,7 +7945,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -7979,7 +7979,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10099,7 +10099,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -10133,7 +10133,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -12241,7 +12241,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -12275,7 +12275,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -14379,7 +14379,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -14413,7 +14413,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -16519,7 +16519,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -16553,7 +16553,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -18657,7 +18657,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -18691,7 +18691,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.giftcardclass.html b/docs/dyn/walletobjects_v1.giftcardclass.html index 2c9e7e5723..b3de7519f6 100644 --- a/docs/dyn/walletobjects_v1.giftcardclass.html +++ b/docs/dyn/walletobjects_v1.giftcardclass.html @@ -834,7 +834,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -891,7 +891,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -1943,7 +1943,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2000,7 +2000,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3040,7 +3040,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3097,7 +3097,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4136,7 +4136,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4193,7 +4193,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5248,7 +5248,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5305,7 +5305,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6348,7 +6348,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6405,7 +6405,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7444,7 +7444,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -7501,7 +7501,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8542,7 +8542,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8599,7 +8599,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9638,7 +9638,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9695,7 +9695,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html index a44841db2f..a1e3e1782c 100644 --- a/docs/dyn/walletobjects_v1.giftcardobject.html +++ b/docs/dyn/walletobjects_v1.giftcardobject.html @@ -1166,7 +1166,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1223,7 +1223,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3014,7 +3014,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3071,7 +3071,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4850,7 +4850,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4907,7 +4907,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6685,7 +6685,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6742,7 +6742,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8536,7 +8536,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8593,7 +8593,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10375,7 +10375,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10432,7 +10432,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -12210,7 +12210,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -12267,7 +12267,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -14047,7 +14047,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -14104,7 +14104,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -15882,7 +15882,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -15939,7 +15939,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html index 5ce017605f..c4b728778a 100644 --- a/docs/dyn/walletobjects_v1.jwt.html +++ b/docs/dyn/walletobjects_v1.jwt.html @@ -910,7 +910,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -937,7 +937,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2423,7 +2423,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#eventTicketClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2450,7 +2450,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4282,7 +4282,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -4316,7 +4316,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5944,7 +5944,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightClass"`. "languageOverride": "A String", # If this field is present, boarding passes served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. @@ -5978,7 +5978,7 @@

Method Details

"localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8973,7 +8973,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9030,7 +9030,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10394,7 +10394,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#giftCardClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10451,7 +10451,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -11941,7 +11941,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -11998,7 +11998,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -13454,7 +13454,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -13511,7 +13511,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -15075,7 +15075,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -15132,7 +15132,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -16524,7 +16524,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -16581,7 +16581,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -18322,7 +18322,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -18349,7 +18349,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -20016,7 +20016,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -20043,7 +20043,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.loyaltyclass.html b/docs/dyn/walletobjects_v1.loyaltyclass.html index 0b9509d990..21784b7743 100644 --- a/docs/dyn/walletobjects_v1.loyaltyclass.html +++ b/docs/dyn/walletobjects_v1.loyaltyclass.html @@ -885,7 +885,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -942,7 +942,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2093,7 +2093,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2150,7 +2150,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3289,7 +3289,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3346,7 +3346,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4484,7 +4484,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4541,7 +4541,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5695,7 +5695,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5752,7 +5752,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6894,7 +6894,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6951,7 +6951,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8089,7 +8089,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8146,7 +8146,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9286,7 +9286,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9343,7 +9343,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10481,7 +10481,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10538,7 +10538,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html index 7b169c0186..087b65e0ed 100644 --- a/docs/dyn/walletobjects_v1.loyaltyobject.html +++ b/docs/dyn/walletobjects_v1.loyaltyobject.html @@ -1213,7 +1213,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1270,7 +1270,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3210,7 +3210,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3267,7 +3267,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5195,7 +5195,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5252,7 +5252,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7179,7 +7179,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -7236,7 +7236,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9179,7 +9179,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9236,7 +9236,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -11186,7 +11186,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -11243,7 +11243,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -13172,7 +13172,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -13229,7 +13229,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -15156,7 +15156,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -15213,7 +15213,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -17142,7 +17142,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -17199,7 +17199,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -19126,7 +19126,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#loyaltyClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -19183,7 +19183,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.offerclass.html b/docs/dyn/walletobjects_v1.offerclass.html index 8c46ae828c..38029269d3 100644 --- a/docs/dyn/walletobjects_v1.offerclass.html +++ b/docs/dyn/walletobjects_v1.offerclass.html @@ -854,7 +854,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -911,7 +911,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2000,7 +2000,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2057,7 +2057,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3134,7 +3134,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3191,7 +3191,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4267,7 +4267,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4324,7 +4324,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5416,7 +5416,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5473,7 +5473,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6553,7 +6553,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6610,7 +6610,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -7686,7 +7686,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -7743,7 +7743,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8821,7 +8821,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8878,7 +8878,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9954,7 +9954,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10011,7 +10011,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html index ed092a1017..c4cda50497 100644 --- a/docs/dyn/walletobjects_v1.offerobject.html +++ b/docs/dyn/walletobjects_v1.offerobject.html @@ -1177,7 +1177,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1234,7 +1234,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3051,7 +3051,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3108,7 +3108,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4913,7 +4913,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4970,7 +4970,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6774,7 +6774,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6831,7 +6831,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8651,7 +8651,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8708,7 +8708,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10516,7 +10516,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10573,7 +10573,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -12377,7 +12377,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -12434,7 +12434,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -14240,7 +14240,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -14297,7 +14297,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -16101,7 +16101,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#offerClass"`. "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -16158,7 +16158,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.transitclass.html b/docs/dyn/walletobjects_v1.transitclass.html index 1bdd84e2a0..92e85121c6 100644 --- a/docs/dyn/walletobjects_v1.transitclass.html +++ b/docs/dyn/walletobjects_v1.transitclass.html @@ -1121,7 +1121,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1148,7 +1148,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -2509,7 +2509,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -2536,7 +2536,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -3885,7 +3885,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -3912,7 +3912,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -5260,7 +5260,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -5287,7 +5287,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6651,7 +6651,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6678,7 +6678,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -8030,7 +8030,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -8057,7 +8057,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9405,7 +9405,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9432,7 +9432,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -10782,7 +10782,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -10809,7 +10809,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -12157,7 +12157,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -12184,7 +12184,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html index 8630788b17..8aa38d1959 100644 --- a/docs/dyn/walletobjects_v1.transitobject.html +++ b/docs/dyn/walletobjects_v1.transitobject.html @@ -1447,7 +1447,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -1474,7 +1474,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -4015,7 +4015,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -4042,7 +4042,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -6571,7 +6571,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -6598,7 +6598,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -9126,7 +9126,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -9153,7 +9153,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -11697,7 +11697,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -11724,7 +11724,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -14256,7 +14256,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -14283,7 +14283,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -16811,7 +16811,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -16838,7 +16838,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -19368,7 +19368,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -19395,7 +19395,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". @@ -21923,7 +21923,7 @@

Method Details

], "showLastUpdateTime": True or False, }, - "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "issuerName": "A String", # Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead. "languageOverride": "A String", # If this field is present, transit tickets served to a user's device will always be in this language. Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". "linksModuleData": { # Links module data. If links module data is also defined on the object, both will be displayed. "uris": [ # The list of URIs. @@ -21950,7 +21950,7 @@

Method Details

}, ], }, - "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. + "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". diff --git a/docs/dyn/webcontentpublisher_v1.organizations.publications.ctas.html b/docs/dyn/webcontentpublisher_v1.organizations.publications.ctas.html index 293e2d5612..f6c6d92cfc 100644 --- a/docs/dyn/webcontentpublisher_v1.organizations.publications.ctas.html +++ b/docs/dyn/webcontentpublisher_v1.organizations.publications.ctas.html @@ -108,7 +108,7 @@

Method Details

The object takes the form of: { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -129,7 +129,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. @@ -155,7 +155,7 @@

Method Details

An object of the form: { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -176,7 +176,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. @@ -208,7 +208,7 @@

Method Details

An object of the form: { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -229,7 +229,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. @@ -265,7 +265,7 @@

Method Details

{ # Response message for `ListCtas`. "ctas": [ # Output only. The list of CTAs. { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -286,7 +286,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. @@ -330,7 +330,7 @@

Method Details

The object takes the form of: { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -351,7 +351,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. @@ -377,7 +377,7 @@

Method Details

An object of the form: { # Represents a Call-To-Action (CTA) configuration for a publication. - "displayName": "A String", # Required. The user-visible display name of the CTA. + "displayName": "A String", # Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation. "name": "A String", # Identifier. The resource name of the Cta. Format: organizations/{organization}/publications/{publication}/ctas/{cta} "newsletterConfig": { # Configuration for newsletter signup calls-to-action (CTAs). # Optional. Configuration specific to newsletter signup CTAs. Only populated if type is `NEWSLETTER_SIGNUP`. "customConsentText": "A String", # Optional. Custom consent or disclosure text shown to the user. @@ -398,7 +398,7 @@

Method Details

}, ], "categoryLabel": "A String", # Optional. Reporting category label sent to Google Analytics (up to 100 characters). - "displayText": "A String", # Optional. The question prompt displayed to readers (up to 140 characters). + "displayText": "A String", # Required. The question prompt displayed to readers (up to 140 characters). "id": "A String", # Output only. Server-assigned unique identifier for the custom question. }, "presetQuestion": { # A preset question referencing a template in the survey question catalog. # Optional. A question selected from the preset question catalog. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 8b33a37a26..506b859602 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -130,6 +130,7 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. }, ], + "consoleBaseUrl": "A String", # Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set. "controlPlaneIp": "A String", # Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. "createTime": "A String", # Output only. Time when this workstation cluster was created. "degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. The conditions field contains detailed information about the status of the cluster. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 2a9a7554c0..424512b21d 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -254,6 +254,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 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. @@ -492,6 +494,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 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. @@ -719,6 +723,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 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. @@ -899,6 +905,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 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. @@ -1094,6 +1102,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 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. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 5ca1dfe68e..8b1ccacd90 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1003,7 +1003,7 @@ "folders": { "methods": { "lookupConfiguredServicePerimeter": { -"description": "Looks up the configured service perimeter for a given resource. Format: `['projects/{projectNumber}', 'folders/{folderNumber}']`.", +"description": "Looks up the configured ServicePerimeter for a given resource.", "flatPath": "v1/folders/{foldersId}:lookupConfiguredServicePerimeter", "httpMethod": "GET", "id": "accesscontextmanager.folders.lookupConfiguredServicePerimeter", @@ -1012,7 +1012,7 @@ ], "parameters": { "resource": { -"description": "Required. The resource to resolve (for example, `projects/123` or `folders/456`).", +"description": "Required. The resource name. Format: `projects/{project_number}` or `folders/{folder_number}` (for example, `projects/123` or `folders/456`)", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -1357,7 +1357,7 @@ "projects": { "methods": { "lookupConfiguredServicePerimeter": { -"description": "Looks up the configured service perimeter for a given resource. Format: `['projects/{projectNumber}', 'folders/{folderNumber}']`.", +"description": "Looks up the configured ServicePerimeter for a given resource.", "flatPath": "v1/projects/{projectsId}:lookupConfiguredServicePerimeter", "httpMethod": "GET", "id": "accesscontextmanager.projects.lookupConfiguredServicePerimeter", @@ -1366,7 +1366,7 @@ ], "parameters": { "resource": { -"description": "Required. The resource to resolve (for example, `projects/123` or `folders/456`).", +"description": "Required. The resource name. Format: `projects/{project_number}` or `folders/{folder_number}` (for example, `projects/123` or `folders/456`)", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -1439,7 +1439,7 @@ } } }, -"revision": "20261027", +"revision": "20261108", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -2389,7 +2389,7 @@ "type": "object" }, "LookupConfiguredServicePerimeterResponse": { -"description": "A configured service perimeter returned by Access Context Manager.", +"description": "A configured ServicePerimeter returned by Access Context Manager.", "id": "LookupConfiguredServicePerimeterResponse", "properties": { "restrictedResource": { @@ -2401,11 +2401,11 @@ "type": "string" }, "servicePerimeter": { -"description": "Fully qualified name of the configured enforced perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no enforced perimeter applies.", +"description": "Fully qualified name of the configured enforced perimeter. This field is empty if no enforced perimeter applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}`", "type": "string" }, "servicePerimeterDryRun": { -"description": "Fully qualified name of the configured dry-run perimeter. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}` This field is empty if no dry-run perimeter configuration applies.", +"description": "Fully qualified name of the configured dry-run perimeter. This field is empty if no dry-run perimeter configuration applies. Format: `accessPolicies/{policy_id}/servicePerimeters/{perimeter_name}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 52aa57fa03..d318949848 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -134,7 +134,8 @@ "scopes": [ "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" -] +], +"streamingType": "NONE" }, "list": { "description": "Lists the AdMob publisher account that was most recently signed in to from the AdMob UI. For more information, see https://support.google.com/admob/answer/10243672.", @@ -162,7 +163,8 @@ "scopes": [ "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" -] +], +"streamingType": "NONE" } }, "resources": { @@ -202,7 +204,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/admob.readonly" -] +], +"streamingType": "NONE" } } }, @@ -242,7 +245,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/admob.readonly" -] +], +"streamingType": "NONE" } } }, @@ -275,7 +279,8 @@ "scopes": [ "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" -] +], +"streamingType": "SERVER_SIDE" } } }, @@ -308,14 +313,15 @@ "scopes": [ "https://www.googleapis.com/auth/admob.readonly", "https://www.googleapis.com/auth/admob.report" -] +], +"streamingType": "SERVER_SIDE" } } } } } }, -"revision": "20261106", +"revision": "20261111", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index 7087ae5edd..316ebf5bb8 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -739,7 +739,7 @@ } } }, -"revision": "20261106", +"revision": "20261111", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1.json b/googleapiclient/discovery_cache/documents/agentregistry.v1.json index b6724d3698..d557313aa4 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1.json @@ -2130,7 +2130,7 @@ } } }, -"revision": "20261029", +"revision": "20261108", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { @@ -2851,7 +2851,7 @@ "id": "Frontmatter", "properties": { "compatibility": { -"description": "Optional. Environmental dependencies or local sidecars.", +"description": "Optional. Environmental dependencies or companion services.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json index 44abe3c113..1b04cf2173 100644 --- a/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentregistry.v1alpha.json @@ -2130,7 +2130,7 @@ } } }, -"revision": "20261029", +"revision": "20261108", "rootUrl": "https://agentregistry.googleapis.com/", "schemas": { "A2ASkill": { @@ -2881,7 +2881,7 @@ "id": "Frontmatter", "properties": { "compatibility": { -"description": "Optional. Environmental dependencies or local sidecars.", +"description": "Optional. Environmental dependencies or companion services.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index fd797de19e..619af949b4 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -10,6 +10,12 @@ }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud services and see the email address of your Google Account" +}, +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite": { +"description": "View your Agentspace chat history, including uploaded files and generated reports and visualizations, and interact with the Agentspace assistant on your behalf. Also view the artifacts you access through NotebookLM Enterprise." +}, +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite": { +"description": "Interact with Discovery Engine API products, such as Agentspace, Vertex AI Search, or NotebookLM Enterprise, on your behalf. It will also allow the app to view all data that you have access to when you use or interact with a Discovery Engine API product." } } } @@ -537,7 +543,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -701,7 +709,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1036,7 +1046,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1202,7 +1214,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1364,7 +1378,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1731,7 +1747,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1893,7 +1911,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2059,7 +2079,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2465,7 +2487,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2605,7 +2629,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -2741,7 +2767,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -2881,7 +2909,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -3017,7 +3047,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -3185,7 +3217,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3347,7 +3381,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3509,7 +3545,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3673,7 +3711,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3837,7 +3877,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4001,7 +4043,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4311,7 +4355,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4473,7 +4519,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4639,7 +4687,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4803,7 +4853,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4967,7 +5019,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5129,7 +5183,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5293,7 +5349,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5457,7 +5515,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5623,7 +5683,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5785,7 +5847,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5949,7 +6013,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6113,7 +6179,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6277,7 +6345,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6441,7 +6511,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6603,7 +6675,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6761,7 +6835,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6925,7 +7001,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8416,7 +8494,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8740,7 +8820,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9363,7 +9445,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9639,7 +9723,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9801,7 +9887,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -10168,7 +10256,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -10411,7 +10501,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -10763,7 +10855,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -11887,7 +11981,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -13157,7 +13253,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -13293,7 +13391,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -14168,7 +14268,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -14304,7 +14406,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "listWait": { @@ -15446,7 +15550,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -15608,7 +15714,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -15770,7 +15878,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -16089,7 +16199,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -16560,7 +16672,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -16941,7 +17055,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -17600,7 +17716,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -17832,7 +17950,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -18364,7 +18484,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -18845,7 +18967,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -19265,7 +19389,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -19530,7 +19656,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -19752,7 +19880,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -20161,7 +20291,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -20925,7 +21057,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -21194,7 +21328,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -21744,7 +21880,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22197,7 +22335,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22577,7 +22717,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22957,7 +23099,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -23119,7 +23263,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -23464,7 +23610,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -23849,7 +23997,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -24877,7 +25027,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -25164,7 +25316,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -25330,7 +25484,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26196,7 +26352,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26428,7 +26586,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26743,7 +26903,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -26981,7 +27143,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -27359,7 +27523,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -27747,7 +27913,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28129,7 +28297,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28453,7 +28623,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28804,7 +28976,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28968,7 +29142,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -29293,7 +29469,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -29601,7 +29779,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -30047,7 +30227,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -30213,7 +30395,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -30857,7 +31041,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31248,7 +31434,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31680,7 +31868,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31846,7 +32036,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -32165,7 +32357,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -32486,7 +32680,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -32926,7 +33122,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33088,7 +33286,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33254,7 +33454,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33717,7 +33919,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33879,7 +34083,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -34194,7 +34400,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -34432,7 +34640,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -34810,7 +35020,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -34927,7 +35139,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35093,7 +35307,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35257,7 +35473,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35421,7 +35639,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35585,7 +35805,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35749,7 +35971,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35913,7 +36137,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36075,7 +36301,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36241,7 +36469,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36407,7 +36637,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36569,7 +36801,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36731,7 +36965,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36897,7 +37133,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -37061,7 +37299,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -37225,7 +37465,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -37373,7 +37615,7 @@ } } }, -"revision": "20261106", +"revision": "20261107", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionExperimentsResponse": { @@ -37743,7 +37985,7 @@ "type": "array" }, "temporalSmoothness": { -"description": "Optional.", +"description": "Optional. How much to temporally smooth the 3D fitting optimization (the fitting server's `temporal_weight`). Must be finite and >= 0. Defaults to the fitting server's default (10) if unset.", "format": "float", "type": "number" } @@ -38725,6 +38967,10 @@ "description": "Code execution result step.", "id": "GenaiVertexV1CodeExecutionResultStep", "properties": { +"content": { +"$ref": "GenaiVertexV1ContentList", +"description": "Multimodal output of the code execution." +}, "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" @@ -39059,12 +39305,32 @@ "enum": [ "TYPE_UNSPECIFIED", "TYPE_PDF", -"TYPE_CSV" +"TYPE_CSV", +"TYPE_PPTX", +"TYPE_PPT", +"TYPE_ODP", +"TYPE_DOCX", +"TYPE_DOC", +"TYPE_DOTX", +"TYPE_ODT", +"TYPE_XLSX", +"TYPE_XLS", +"TYPE_ODS" ], "enumDescriptions": [ "", "PDF document format", -"CSV document format" +"CSV document format", +"PPTX presentation format", +"PPT presentation format", +"ODP presentation format", +"DOCX document format", +"DOC document format", +"DOTX document template format", +"ODT document format", +"XLSX spreadsheet format", +"XLS spreadsheet format", +"ODS spreadsheet format" ], "type": "string" }, @@ -40895,6 +41161,17 @@ false }, "type": "object" }, +"GenaiVertexV1SmartTranscriptionMode": { +"description": "Configuration for smart transcription mode.", +"id": "GenaiVertexV1SmartTranscriptionMode", +"properties": { +"sourceText": { +"description": "The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text.", +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1SpeakerConfig": { "description": "Configuration for multi-speaker and speech generation.", "id": "GenaiVertexV1SpeakerConfig", @@ -41387,6 +41664,22 @@ false }, "type": "array" }, +"modeConfig": { +"$ref": "GenaiVertexV1TranscriptionMode" +}, +"modeEnum": { +"enum": [ +"MODE_UNSPECIFIED", +"VERBATIM", +"SMART" +], +"enumDescriptions": [ +"Unspecified transcription mode.", +"Verbatim transcription mode.", +"Smart transcription mode." +], +"type": "string" +}, "timestampGranularities": { "deprecated": true, "description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", @@ -41398,6 +41691,19 @@ false }, "type": "object" }, +"GenaiVertexV1TranscriptionMode": { +"description": "Configuration for transcription mode.", +"id": "GenaiVertexV1TranscriptionMode", +"properties": { +"smart": { +"$ref": "GenaiVertexV1SmartTranscriptionMode" +}, +"verbatim": { +"$ref": "GenaiVertexV1VerbatimTranscriptionMode" +} +}, +"type": "object" +}, "GenaiVertexV1UrlCitation": { "description": "A URL citation annotation.", "id": "GenaiVertexV1UrlCitation", @@ -41615,6 +41921,24 @@ false }, "type": "object" }, +"GenaiVertexV1VerbatimTranscriptionMode": { +"description": "Configuration for verbatim transcription mode.", +"id": "GenaiVertexV1VerbatimTranscriptionMode", +"properties": { +"diarizationMode": { +"description": "Optional. Configures speaker diarization. Supported values: \"speaker\".", +"type": "string" +}, +"timestampGranularities": { +"description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GenaiVertexV1VertexAISearchConfig": { "description": "Used to specify configuration for VertexAISearch.", "id": "GenaiVertexV1VertexAISearchConfig", @@ -42130,8 +42454,7 @@ false }, "status": { "$ref": "GoogleCloudAiplatformV1AgentStatus", -"description": "Output only. The current operational state of the agent.", -"readOnly": true +"description": "Optional. The current operational state of the agent." }, "system_instruction": { "description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", @@ -42315,22 +42638,23 @@ false "type": "string" }, "state": { -"description": "Output only. The current state of the agent.", +"description": "Optional. The current state of the agent.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SUSPENDED", "ARCHIVED", -"DELETED" +"DELETED", +"PROVISIONING" ], "enumDescriptions": [ "Unspecified agent state.", "The agent is active and ready to process requests.", "The agent is suspended.", "The agent is archived (read-only).", -"The agent is soft-deleted." +"The agent is soft-deleted.", +"The agent has been created and is awaiting post-creation provisioning before becoming active." ], -"readOnly": true, "type": "string" }, "suspensionReason": { @@ -42379,7 +42703,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", +"description": "Optional. Not used; the tool is resolved from `name` via Agent Registry.", "type": "object" }, "name": { @@ -42387,11 +42711,11 @@ false "type": "string" }, "type": { -"description": "Required. The type of the tool. Supported types: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation`", +"description": "Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation`", "type": "string" }, "url": { -"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.", +"description": "Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required.", "type": "string" } }, @@ -54134,7 +54458,7 @@ false }, "groundingTypes": { "$ref": "GoogleCloudAiplatformV1GoogleMapsGroundingTypes", -"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." +"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing." } }, "type": "object" @@ -54149,7 +54473,7 @@ false }, "routing": { "$ref": "GoogleCloudAiplatformV1GoogleMapsRouting", -"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." +"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified." } }, "type": "object" @@ -54161,7 +54485,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1GoogleMapsRouting": { -"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", +"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified.", "id": "GoogleCloudAiplatformV1GoogleMapsRouting", "properties": {}, "type": "object" @@ -61353,6 +61677,10 @@ false "description": "Observability settings for one agent's sessions.", "id": "GoogleCloudAiplatformV1ObservabilityConfig", "properties": { +"artifactGcsBucket": { +"description": "Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted.", +"type": "string" +}, "observabilityEnabled": { "description": "Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored.", "type": "boolean" @@ -65636,7 +65964,7 @@ false "id": "GoogleCloudAiplatformV1ReasoningEngineSpecBuildSpec", "properties": { "serviceAccount": { -"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", +"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for private pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", "type": "string" }, "workerPool": { @@ -72628,13 +72956,15 @@ false "SERVING_PROFILE_SCOPE_UNSPECIFIED", "GEMINI_LIVE", "INTERACTIONS_API", -"RESPONSE_API" +"RESPONSE_API", +"VOICES_API" ], "enumDescriptions": [ "Default value. This value is unused. When users create a ServingProfile, they must choose a scope.", "The scope for Gemini Live.", "The scope for Interactions API.", -"The scope for Response API." +"The scope for Response API.", +"The scope for Voices API." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 8bea162e0d..92f21586d6 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -447,7 +447,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -611,7 +613,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -871,7 +875,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -988,7 +994,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1152,7 +1160,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1487,7 +1497,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1653,7 +1665,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -1815,7 +1829,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2182,7 +2198,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2344,7 +2362,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2510,7 +2530,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -2674,7 +2696,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3082,7 +3106,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3220,7 +3246,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3358,7 +3386,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3464,7 +3494,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3602,7 +3634,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3766,7 +3800,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -3930,7 +3966,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4094,7 +4132,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4234,7 +4274,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4372,7 +4414,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4508,7 +4552,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4648,7 +4694,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4784,7 +4832,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -4952,7 +5002,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5114,7 +5166,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5276,7 +5330,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5440,7 +5496,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5604,7 +5662,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -5768,7 +5828,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6043,7 +6105,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6588,7 +6652,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6820,7 +6886,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -6986,7 +7054,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7150,7 +7220,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7314,7 +7386,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7476,7 +7550,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7640,7 +7716,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7804,7 +7882,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -7968,7 +8048,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8134,7 +8216,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8296,7 +8380,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8460,7 +8546,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8624,7 +8712,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8788,7 +8878,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -8952,7 +9044,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9114,7 +9208,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9272,7 +9368,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -9436,7 +9534,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -10697,7 +10797,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -10981,7 +11083,8 @@ "useMediaDownloadService": true }, "downloadArtifact": { -"description": "Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.", +"deprecated": true, +"description": "Deprecated: use `ArtifactService.DownloadArtifact` instead. Pass this request's `task` as its `name`, the same `path`, and, for a preview, the same `processing_config.output_mime_type`; the file is served as media through Scotty rather than streamed through this service, without this method's 1 GiB cap. `ArtifactService.PreviewArtifact` also returns a converted file as a stream. This method keeps working unchanged while callers migrate. Downloads a file from a task's workspace as a stream of chunks. A server-streaming RPC. The response body is the file's raw bytes, with the file's own media type as the `Content-Type`. At most 1 GiB. Like ListTaskArtifacts, reads from the running sandbox when there is one, so a file the agent has just written is returned even before it reaches storage.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:downloadArtifact", "httpMethod": "GET", "id": "aiplatform.projects.locations.agents.tasks.downloadArtifact", @@ -11144,6 +11247,45 @@ "https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, +"listEvents": { +"description": "Lists a task's execution events -- trajectory steps, status changes, and task detail and artifact updates -- one page at a time. The unary counterpart of StreamTask with `snapshot` set: it reads the same stored events, in the same order and with the same content, and returns them in pages instead of on a stream, for callers that cannot hold a stream open. Like StreamTask, it reads the task's trajectory from interaction storage and never restores the runtime actor. Unlike StreamTask, it never waits: a task that has not started running yet returns no events. Storage can trail the live stream by a few seconds, so the newest events a participant sees on CreateTaskBidiStream may not be listed yet.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:listEvents", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.agents.tasks.listEvents", +"parameterOrder": [ +"task" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of events to return. The service may return fewer. If unspecified (or <= 0), at most 100 are returned. The maximum is 1000; larger values are capped to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token from a previous ListTaskEvents call. Listing continues immediately after the last event of that page. Following `next_page_token` from page to page never skips or repeats an event. This token is the same token that the StreamTask API uses and hence could be used interchangeably. Opaque: pass it back unchanged and send it only to the task it was issued for. A token this call cannot redeem is rejected with INVALID_ARGUMENT rather than listing from the start. When paginating, all other parameters except `page_size` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"task": { +"description": "Required. The task whose events to list. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+task}:listEvents", +"response": { +"$ref": "GoogleCloudAiplatformV1beta1ListTaskEventsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, "patch": { "description": "Updates a task's mutable fields (e.g. schedule, priority, title). Typically allowed while the task is IDLE.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}", @@ -11332,7 +11474,8 @@ "supportsMediaUpload": true }, "uploadArtifact": { -"description": "Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.", +"deprecated": true, +"description": "Deprecated: use `ArtifactService.UploadArtifact` instead. Pass this request's `task` as its `name` and the same `path`, and send the file as media to `POST /upload/v1beta1/{name}:upload`. UploadArtifact stores the file through Scotty, takes files up to 10 GiB, and returns the stored `path`; `ArtifactService.ListWorkspaceArtifacts` returns the rest of the file's `TaskArtifactFile`. This method keeps working unchanged while callers migrate. Uploads a file into a task's workspace. A client-streaming RPC: the request body is the file's raw bytes, relayed to storage a chunk at a time, so neither ESF nor this server holds the whole file. A broken connection restarts the upload from zero. `path` must be an absolute path under `/workspace/userdata/`. The task must not be in a terminal state. An existing file at `path` is replaced. At most 1 GiB.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}:uploadArtifact", "httpMethod": "POST", "id": "aiplatform.projects.locations.agents.tasks.uploadArtifact", @@ -11397,7 +11540,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -11449,6 +11594,37 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" +] +}, +"move": { +"description": "Moves a file, including a `.link.json` link, from `path` in a task's workspace to `destination_path` in `destination_parent`'s workspace.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/tasks/{tasksId}/artifacts:move", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.agents.tasks.artifacts.move", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The task whose workspace holds the file. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+/tasks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/artifacts:move", +"request": { +"$ref": "GoogleCloudAiplatformV1beta1MoveArtifactRequest" +}, +"response": { +"$ref": "GoogleCloudAiplatformV1beta1MoveArtifactResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -11485,7 +11661,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "remove": { @@ -11514,7 +11692,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } @@ -11601,7 +11781,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -12024,7 +12206,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "delete": { @@ -12076,7 +12260,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -12113,7 +12299,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "patch": { @@ -12181,7 +12369,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -12233,7 +12423,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "preview": { @@ -12269,7 +12461,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "remove": { @@ -12298,7 +12492,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] } } @@ -12379,7 +12575,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -12652,7 +12850,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -12976,7 +13176,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -13657,7 +13859,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -13933,7 +14137,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -14095,7 +14301,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -14462,7 +14670,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -14705,7 +14915,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -15057,7 +15269,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -15475,7 +15689,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -16686,7 +16902,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -17175,7 +17393,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -17473,7 +17693,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -17733,7 +17955,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -18064,7 +18288,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -18642,7 +18868,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -18806,7 +19034,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -19187,7 +19417,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -19861,7 +20093,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -20222,7 +20456,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -20358,7 +20594,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -21261,7 +21499,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -21397,7 +21637,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22551,7 +22793,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22713,7 +22957,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -22875,7 +23121,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -23194,7 +23442,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -23665,7 +23915,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -24074,7 +24326,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -24430,7 +24684,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -24931,7 +25187,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -25163,7 +25421,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -25695,7 +25955,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26176,7 +26438,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26596,7 +26860,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -26861,7 +27127,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -27083,7 +27351,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -27492,7 +27762,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28017,7 +28289,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -28776,7 +29050,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -29045,7 +29321,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -29353,8 +29631,8 @@ ], "enumDescriptions": [ "The default view: BASIC.", -"Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", -"Full view includes all fields, including the detailed assessment." +"Includes every `AnalyzedSession` field except `assessment`.", +"Includes all fields, including the detailed `assessment`. AgentAnomalyDetectionService.ListAnalyzedSessions omits `assessment` in every view. To get it, call AgentAnomalyDetectionService.GetAnalyzedSession with this view." ], "location": "query", "type": "string" @@ -29414,8 +29692,8 @@ ], "enumDescriptions": [ "The default view: BASIC.", -"Basic view includes only the fields needed for the list table (name, session_id, created_time, severity counts).", -"Full view includes all fields, including the detailed assessment." +"Includes every `AnalyzedSession` field except `assessment`.", +"Includes all fields, including the detailed `assessment`. AgentAnomalyDetectionService.ListAnalyzedSessions omits `assessment` in every view. To get it, call AgentAnomalyDetectionService.GetAnalyzedSession with this view." ], "location": "query", "type": "string" @@ -30020,7 +30298,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -30473,7 +30753,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -30909,7 +31191,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31289,7 +31573,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31451,7 +31737,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -31796,7 +32084,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -32181,7 +32471,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33339,7 +33631,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -33811,7 +34105,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -34191,7 +34487,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -35846,7 +36144,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -36182,7 +36482,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36679,7 +36981,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -36911,7 +37215,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -38088,7 +38394,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -38345,7 +38653,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -38664,7 +38974,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -39117,7 +39429,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -39552,7 +39866,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -39934,7 +40250,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -40258,7 +40576,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -40609,7 +40929,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -40964,7 +41286,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -41172,7 +41496,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -41465,7 +41791,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -41773,7 +42101,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -42219,7 +42549,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -42613,7 +42945,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -43338,7 +43672,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -43729,7 +44065,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -44161,7 +44499,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -44327,7 +44667,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -44646,7 +44988,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -45054,7 +45398,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -45806,7 +46152,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -45968,7 +46316,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -46134,7 +46484,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -47463,7 +47815,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -47580,7 +47934,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -48077,7 +48433,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -48309,7 +48667,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -49395,7 +49755,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -49652,7 +50014,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -49971,7 +50335,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -50424,7 +50790,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -50831,7 +51199,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -50997,7 +51367,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51161,7 +51533,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51325,7 +51699,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51489,7 +51865,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51627,7 +52005,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51759,7 +52139,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -51923,7 +52305,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52085,7 +52469,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52251,7 +52637,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52417,7 +52805,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52579,7 +52969,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52741,7 +53133,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -52907,7 +53301,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -53071,7 +53467,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "list": { @@ -53235,7 +53633,9 @@ }, "scopes": [ "https://www.googleapis.com/auth/aiplatform", -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/discoveryengine.assist.readwrite", +"https://www.googleapis.com/auth/discoveryengine.serving.readwrite" ] }, "wait": { @@ -53400,7 +53800,7 @@ } } }, -"revision": "20261106", +"revision": "20261107", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionExperimentsResponse": { @@ -53770,7 +54170,7 @@ "type": "array" }, "temporalSmoothness": { -"description": "Optional.", +"description": "Optional. How much to temporally smooth the 3D fitting optimization (the fitting server's `temporal_weight`). Must be finite and >= 0. Defaults to the fitting server's default (10) if unset.", "format": "float", "type": "number" } @@ -55134,6 +55534,10 @@ "description": "Code execution result step.", "id": "GenaiCodeExecutionResultStep", "properties": { +"content": { +"$ref": "GenaiContentList", +"description": "Multimodal output of the code execution." +}, "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" @@ -55212,12 +55616,32 @@ "enum": [ "TYPE_UNSPECIFIED", "TYPE_PDF", -"TYPE_CSV" +"TYPE_CSV", +"TYPE_PPTX", +"TYPE_PPT", +"TYPE_ODP", +"TYPE_DOCX", +"TYPE_DOC", +"TYPE_DOTX", +"TYPE_ODT", +"TYPE_XLSX", +"TYPE_XLS", +"TYPE_ODS" ], "enumDescriptions": [ "", "PDF document format", -"CSV document format" +"CSV document format", +"PPTX presentation format", +"PPT presentation format", +"ODP presentation format", +"DOCX document format", +"DOC document format", +"DOTX document template format", +"ODT document format", +"XLSX spreadsheet format", +"XLS spreadsheet format", +"ODS spreadsheet format" ], "type": "string" }, @@ -57610,6 +58034,10 @@ "description": "Code execution result step.", "id": "GenaiVertexV1beta1CodeExecutionResultStep", "properties": { +"content": { +"$ref": "GenaiVertexV1beta1ContentList", +"description": "Multimodal output of the code execution." +}, "isError": { "description": "Whether the code execution resulted in an error.", "type": "boolean" @@ -57944,12 +58372,32 @@ "enum": [ "TYPE_UNSPECIFIED", "TYPE_PDF", -"TYPE_CSV" +"TYPE_CSV", +"TYPE_PPTX", +"TYPE_PPT", +"TYPE_ODP", +"TYPE_DOCX", +"TYPE_DOC", +"TYPE_DOTX", +"TYPE_ODT", +"TYPE_XLSX", +"TYPE_XLS", +"TYPE_ODS" ], "enumDescriptions": [ "", "PDF document format", -"CSV document format" +"CSV document format", +"PPTX presentation format", +"PPT presentation format", +"ODP presentation format", +"DOCX document format", +"DOC document format", +"DOTX document template format", +"ODT document format", +"XLSX spreadsheet format", +"XLS spreadsheet format", +"ODS spreadsheet format" ], "type": "string" }, @@ -60084,6 +60532,17 @@ false }, "type": "object" }, +"GenaiVertexV1beta1SmartTranscriptionMode": { +"description": "Configuration for smart transcription mode.", +"id": "GenaiVertexV1beta1SmartTranscriptionMode", +"properties": { +"sourceText": { +"description": "The source text to be edited or rewritten via voice instructions. When provided, the model performs voice-driven editing and outputs the finalized replacement text.", +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1SpeakerConfig": { "description": "Configuration for multi-speaker and speech generation.", "id": "GenaiVertexV1beta1SpeakerConfig", @@ -60582,6 +61041,22 @@ false }, "type": "array" }, +"modeConfig": { +"$ref": "GenaiVertexV1beta1TranscriptionMode" +}, +"modeEnum": { +"enum": [ +"MODE_UNSPECIFIED", +"VERBATIM", +"SMART" +], +"enumDescriptions": [ +"Unspecified transcription mode.", +"Verbatim transcription mode.", +"Smart transcription mode." +], +"type": "string" +}, "timestampGranularities": { "deprecated": true, "description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", @@ -60593,6 +61068,19 @@ false }, "type": "object" }, +"GenaiVertexV1beta1TranscriptionMode": { +"description": "Configuration for transcription mode.", +"id": "GenaiVertexV1beta1TranscriptionMode", +"properties": { +"smart": { +"$ref": "GenaiVertexV1beta1SmartTranscriptionMode" +}, +"verbatim": { +"$ref": "GenaiVertexV1beta1VerbatimTranscriptionMode" +} +}, +"type": "object" +}, "GenaiVertexV1beta1UrlCitation": { "description": "A URL citation annotation.", "id": "GenaiVertexV1beta1UrlCitation", @@ -60810,6 +61298,24 @@ false }, "type": "object" }, +"GenaiVertexV1beta1VerbatimTranscriptionMode": { +"description": "Configuration for verbatim transcription mode.", +"id": "GenaiVertexV1beta1VerbatimTranscriptionMode", +"properties": { +"diarizationMode": { +"description": "Optional. Configures speaker diarization. Supported values: \"speaker\".", +"type": "string" +}, +"timestampGranularities": { +"description": "Optional. The granularity of timestamps to include in the transcription output. Supported values: \"word\". If empty, no timestamps are generated.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GenaiVertexV1beta1VertexAISearchConfig": { "description": "Used to specify configuration for VertexAISearch.", "id": "GenaiVertexV1beta1VertexAISearchConfig", @@ -62613,8 +63119,7 @@ false }, "status": { "$ref": "GoogleCloudAiplatformV1beta1AgentStatus", -"description": "Output only. The current operational state of the agent.", -"readOnly": true +"description": "Optional. The current operational state of the agent." }, "system_instruction": { "description": "Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction.", @@ -62641,7 +63146,7 @@ false "id": "GoogleCloudAiplatformV1beta1AgentAnomalyDetectionScope", "properties": { "autoEnroll": { -"description": "Optional. When true, agents created in Agent Engine that share log and observability buckets with this scope are automatically enrolled as MonitoredAgents. When false, agents must be enrolled explicitly via MonitoredAgent operations.", +"description": "Optional. When `true`, newly discovered agents that share log and observability buckets with this scope are automatically enrolled as `ACTIVE` MonitoredAgents, up to the project's monitored agent quota. When `false`, newly discovered agents are added as `DISABLED` MonitoredAgents, and you must enable them explicitly through MonitoredAgent operations.", "type": "boolean" }, "displayName": { @@ -62653,7 +63158,7 @@ false "description": "Optional. Immutable. Specifies the customer-managed encryption key spec for a Scope. If set, this Scope and all sub-resources will be secured by this key. The key is immutable after the Scope is created and must be a multi-region (`us` or `eu`) key in the same region as the Scope." }, "logBuckets": { -"description": "Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", +"description": "Required. Customer-owned Cloud Logging bucket resource names attached to this scope. Specify exactly one bucket, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}`.", "items": { "type": "string" }, @@ -62664,7 +63169,7 @@ false "type": "string" }, "observabilityBuckets": { -"description": "Required. Customer-owned Cloud Observability bucket resource names attached to this scope. Format: `projects/{project}/locations/{location}/observationBuckets/{observation_bucket}`.", +"description": "Required. Customer-owned Cloud Observability datasets attached to this scope. Each value is the resource name of a dataset in an Observability bucket, such as the `Spans` dataset in the `_Trace` bucket. Specify exactly one dataset, in the same project as this scope. Format: `projects/{project}/locations/{location}/buckets/{bucket}/datasets/{dataset}`.", "items": { "type": "string" }, @@ -62839,7 +63344,7 @@ false "id": "GoogleCloudAiplatformV1beta1AgentResource", "properties": { "agent": { -"description": "Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", +"description": "Required. The resource name or identifier of the agent to monitor. The format depends on `agent_type`: * `REASONING_ENGINE`: `//aiplatform.googleapis.com/projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`: the full resource name of the Cloud Run service, `//run.googleapis.com/projects/{project}/locations/{location}/services/{service}` * `GKE_WORKLOAD`: the full resource name of the Google Kubernetes Engine cluster followed by the agent's OpenTelemetry `service.name`, `//container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/{service}`. For a zonal cluster, `zones/{zone}` replaces `locations/{location}`. Some names end in `k8s/namespaces/{namespace}/apps/deployments/{deployment}` instead of `{service}`. * `GCE_INSTANCE`: the full resource name of the Compute Engine instance followed by the agent's OpenTelemetry `service.name`, `//compute.googleapis.com/projects/{project}/zones/{zone}/instances/{instance}/{service}`, where `{instance}` is the numeric instance ID. * `AGENT_TYPE_OTHER`: a stable identifier for the agent, such as the full resource name of its runtime or its OpenTelemetry `service.name`.", "type": "string" }, "agentFramework": { @@ -62904,22 +63409,23 @@ false "type": "string" }, "state": { -"description": "Output only. The current state of the agent.", +"description": "Optional. The current state of the agent.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "SUSPENDED", "ARCHIVED", -"DELETED" +"DELETED", +"PROVISIONING" ], "enumDescriptions": [ "Unspecified agent state.", "The agent is active and ready to process requests.", "The agent is suspended.", "The agent is archived (read-only).", -"The agent is soft-deleted." +"The agent is soft-deleted.", +"The agent has been created and is awaiting post-creation provisioning before becoming active." ], -"readOnly": true, "type": "string" }, "suspensionReason": { @@ -62968,7 +63474,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`.", +"description": "Optional. Not used; the tool is resolved from `name` via Agent Registry.", "type": "object" }, "name": { @@ -62976,11 +63482,11 @@ false "type": "string" }, "type": { -"description": "Required. The type of the tool. Supported types: * `audio_generation` * `code_execution` * `endpoint` * `filesystem` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation`", +"description": "Required. The type of the tool. Supported types: * `audio_generation` * `endpoint` * `google_search` * `image_generation` * `mcp_server` * `speech_generation` * `url_context` * `video_generation`", "type": "string" }, "url": { -"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.", +"description": "Optional. The runtime reference is resolved from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), so this is not required.", "type": "string" } }, @@ -63018,7 +63524,7 @@ false "type": "string" }, "agentResourceName": { -"description": "The resource name or identifier of the agent. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", +"description": "The resource name or identifier of the agent. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`. For the format of each agent type, see AgentResource.agent.", "type": "string" }, "agentStatus": { @@ -63232,7 +63738,7 @@ false "type": "string" }, "agentResourceName": { -"description": "Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`: * `REASONING_ENGINE`: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` * `CLOUD_RUN_SERVICE`, `GKE_WORKLOAD`, `GCE_INSTANCE`: the resource name of the agent's runtime. * `AGENT_TYPE_OTHER`: a stable identifier for the agent.", +"description": "Output only. The resource name or identifier of the agent that ran this session. Matches `AgentResource.agent` on the corresponding `MonitoredAgent`, so the format depends on that agent's `AgentResource.agent_type`. For the format of each agent type, see AgentResource.agent.", "readOnly": true, "type": "string" }, @@ -63328,7 +63834,7 @@ false "additionalProperties": { "$ref": "GoogleCloudAiplatformV1beta1AnalyzedSessionSeveritySummary" }, -"description": "Output only. Map of severity counts for listing analyzed sessions. The key is the string representation of Severity. Populated in BASIC view only.", +"description": "Output only. Map of the detectors that flagged this session, grouped by severity. The key is the string representation of `Severity`. Populated only for flagged sessions, in both views. In AgentAnomalyDetectionService.ListAnalyzedSessions responses, the map holds only the session's highest severity.", "readOnly": true, "type": "object" }, @@ -76506,6 +77012,20 @@ false "inlineData": { "$ref": "GoogleCloudAiplatformV1beta1FunctionResponseBlob", "description": "Inline media bytes." +}, +"mediaProcessing": { +"description": "Optional. Processes this part's media for understanding. Only meaningful for video parts (`inline_data` or `file_data` with video mime). Non-video parts ignore this field.", +"enum": [ +"MEDIA_PROCESSING_UNSPECIFIED", +"STATIC", +"AGENTIC" +], +"enumDescriptions": [ +"Defaults to model-specific processing.", +"Fixed-rate frame extraction. All frames placed in context.", +"Model-driven dynamic navigation. Recommended for most use cases." +], +"type": "string" } }, "type": "object" @@ -77899,7 +78419,7 @@ false }, "groundingTypes": { "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsGroundingTypes", -"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset." +"description": "Optional. Specifies the types of Google Maps grounding to enable. Defaults to `places` when unset, and to `places` and `routing` for Gemini 4 and later models. When set, only the listed types are enabled; for example, setting only `places` disables routing." } }, "type": "object" @@ -77914,7 +78434,7 @@ false }, "routing": { "$ref": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", -"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute)." +"description": "Optional. Enables grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no `GroundingTypes` are specified." } }, "type": "object" @@ -77926,7 +78446,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1GoogleMapsRouting": { -"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute).", +"description": "Grounding with Google Maps Routing APIs (ComputeRoutes and SearchAlongRoute). Also enabled by default for Gemini 4 and later models when no grounding type is specified.", "id": "GoogleCloudAiplatformV1beta1GoogleMapsRouting", "properties": {}, "type": "object" @@ -78348,12 +78868,12 @@ false "type": "string" }, "agentModel": { -"description": "Optional. The Vertex AI model the coding agent calls. Only Gemini based Vertex AI models are supported. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model}", +"description": "Required. The Vertex AI model the coding agent calls. Accepts the full Vertex AI model resource name of the form projects/{project}/locations/{location}/publishers/{publisher}/models/{model} The supported models include: * Publisher `google`: `gemini-4-argon` and `gemini-3.8-flash`, etc. * Publisher `anthropic`: `claude-opus-5-5` and `claude-sonnet-5-5`. To use a Claude model, enable it in Model Garden for the project of the evaluation run. If the model is not supported, the evaluation run is not created. The error lists the supported models.", "type": "string" }, "agentModelConfig": { "$ref": "GoogleCloudAiplatformV1beta1GenerationConfig", -"description": "Optional. Generation settings of the model that the coding agent calls. If you do not set this field, the coding agent uses its default settings. Only `thinking_config.thinking_level` is supported. The valid levels are `MINIMAL`, `LOW`, `MEDIUM` and `HIGH`. `antigravity-cli` does not accept a level for Gemini 2.5 models. It accepts `MINIMAL` and `MEDIUM` only for Gemini Flash models. If you set a level that is not valid for the coding agent and the model, inference fails for the candidate." +"description": "Required. Generation settings of the model that the coding agent calls. For a model that does not accept a thinking level, set an empty `agent_model_config`. Only `thinking_config.thinking_level` is supported. The models `gemini-4-argon`, `gemini-3.8-flash`, `claude-opus-5-5`, and `claude-sonnet-5-5` accept `LOW`, `MEDIUM`, and `HIGH`. Set a level that the model accepts, or no level for a model that does not accept a level. Otherwise, the evaluation run is not created. The error lists the levels that the model accepts." } }, "type": "object" @@ -80241,6 +80761,10 @@ false "description": "Optional. The entity's ID in its store, unique within `provider`: a Drive file ID, a Jira issue ID, or, for OneDrive and SharePoint, whose item IDs are unique only within a drive, the drive ID and the drive item ID, e.g. \"{drive-id}/{item-id}\". At most 1024 characters. With `provider`, it identifies the entity: it names the link file and is the idempotency key for `AddArtifact`. When it is unset, `uri` takes its place, so two URIs of one entity, such as a Drive file's /view and /edit URIs, are two entities.", "type": "string" }, +"title": { +"description": "Optional. The entity's title in its store, e.g. a GitHub issue's title, an email's subject or a file's name. At most 1024 characters.", +"type": "string" +}, "updateTime": { "description": "Output only. Last modification time of the link file at `path`, as `ArtifactService.ListWorkspaceArtifacts` read it. Not part of a link file. It is what tells two listings of one entity apart after the entity was updated in place. Such an update leaves every other field alone -- the entity keeps its `uri` and its `source_artifact_id`, so the link file keeps its name -- and it leaves the link file's bytes alone too, because a link file records WHICH entity is linked and not what state that entity is in. The time the file was rewritten is the only thing that moves.", "format": "google-datetime", @@ -81911,6 +82435,28 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ListTaskEventsResponse": { +"description": "Response for TaskService.ListTaskEvents.", +"id": "GoogleCloudAiplatformV1beta1ListTaskEventsResponse", +"properties": { +"assignedAgentIdentity": { +"description": "The resolved Agent Identity (SPIFFE ID) of the `Agent` this task is assigned to, as StreamTask reports on its first message.", +"type": "string" +}, +"events": { +"description": "The task's events, in the order they were delivered: the same events, with the same `seq_num`, that StreamTask returns with `snapshot` set. Each event also carries a `continuation_token` wherever StreamTask issues one. A page carries a `status_changed` event only where the status changed, so the status in effect when the page starts is not repeated on it; read the current status with GetTask.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1TaskServerEvent" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page. Empty only when the task is in a terminal state and every stored event has been returned. While the task can still produce events it is set even when `events` is empty, so a caller can poll with it for events stored later.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1ListTasksResponse": { "description": "Response for TaskService.ListTasks.", "id": "GoogleCloudAiplatformV1beta1ListTasksResponse", @@ -85688,6 +86234,31 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1MoveArtifactRequest": { +"description": "Request for ArtifactService.MoveArtifact.", +"id": "GoogleCloudAiplatformV1beta1MoveArtifactRequest", +"properties": { +"destinationParent": { +"description": "Required. The task or collaborative project to move the file into, in the same project and location as `parent`. Format: projects/{project}/locations/{location}/agents/{agent}/tasks/{task} or projects/{project}/locations/{location}/collaborativeProjects/{collaborative_project}", +"type": "string" +}, +"destinationPath": { +"description": "Required. Absolute path for the file in `destination_parent`'s workspace: under `/workspace/project/` for a collaborative project, and not under it for a task. Fails with `ALREADY_EXISTS` if a file is already there.", +"type": "string" +}, +"path": { +"description": "Required. Absolute path of the file in the task's workspace, e.g. `/workspace/deliverables/report.md`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1MoveArtifactResponse": { +"description": "Response for ArtifactService.MoveArtifact.", +"id": "GoogleCloudAiplatformV1beta1MoveArtifactResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig": { "description": "Configuration for a multi-speaker text-to-speech request.", "id": "GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig", @@ -87152,6 +87723,10 @@ false "description": "Observability settings for one agent's sessions.", "id": "GoogleCloudAiplatformV1beta1ObservabilityConfig", "properties": { +"artifactGcsBucket": { +"description": "Optional. Customer bucket (`gs://bucket`) the media of observed turns is written to; unset means media is not persisted.", +"type": "string" +}, "observabilityEnabled": { "description": "Optional. Enables observability for this agent's sessions: OpenTelemetry span emission covering tool names, model names, token counts, latencies and status. If `false`, the other fields here are ignored.", "type": "boolean" @@ -87163,6 +87738,68 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1OmniHyperParameters": { +"description": "Hyperparameters for Omni LoRA tuning.", +"id": "GoogleCloudAiplatformV1beta1OmniHyperParameters", +"properties": { +"adapterSize": { +"description": "Optional. Adapter size for Omni LoRA tuning.", +"enum": [ +"ADAPTER_SIZE_UNSPECIFIED", +"ADAPTER_SIZE_EIGHT", +"ADAPTER_SIZE_SIXTEEN", +"ADAPTER_SIZE_THIRTY_TWO" +], +"enumDescriptions": [ +"Adapter size is unspecified.", +"Adapter size 8.", +"Adapter size 16.", +"Adapter size 32." +], +"type": "string" +}, +"epochCount": { +"description": "Optional. Number of complete passes the model makes over the entire training dataset during training.", +"format": "int64", +"type": "string" +}, +"learningRateMultiplier": { +"description": "Optional. Multiplier for adjusting the default learning rate.", +"format": "double", +"type": "number" +}, +"tuningTask": { +"description": "Optional. The tuning task for Omni LoRA tuning.", +"enum": [ +"TUNING_TASK_UNSPECIFIED", +"TUNING_TASK_I2V", +"TUNING_TASK_T2V" +], +"enumDescriptions": [ +"Default value. This value is unused.", +"Tuning task for image to video.", +"Tuning task for text to video." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1OmniLoraTuningSpec": { +"description": "Tuning Spec for Omni LoRA Model Tuning.", +"id": "GoogleCloudAiplatformV1beta1OmniLoraTuningSpec", +"properties": { +"hyperParameters": { +"$ref": "GoogleCloudAiplatformV1beta1OmniHyperParameters", +"description": "Optional. Hyperparameters for Omni LoRA tuning." +}, +"trainingDatasetUri": { +"description": "Required. Cloud Storage path to the file containing training dataset for Omni LoRA tuning. The dataset must be formatted as a JSONL file.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1OneOffSchedule": { "description": "A one-off (single) run trigger.", "id": "GoogleCloudAiplatformV1beta1OneOffSchedule", @@ -92397,7 +93034,7 @@ false "id": "GoogleCloudAiplatformV1beta1ReasoningEngineSpecBuildSpec", "properties": { "serviceAccount": { -"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for custom worker pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", +"description": "Optional. The service account that Cloud Build uses to run the build. This field is only applicable when `worker_pool` is specified (i.e., for private pools). If `worker_pool` is not specified, this field is ignored and the build runs using the Google-managed service agent. Format: `projects/{project}/serviceAccounts/{service_account}` or `{service_account}@{project}.iam.gserviceaccount.com`", "type": "string" }, "workerPool": { @@ -100663,13 +101300,15 @@ false "SERVING_PROFILE_SCOPE_UNSPECIFIED", "GEMINI_LIVE", "INTERACTIONS_API", -"RESPONSE_API" +"RESPONSE_API", +"VOICES_API" ], "enumDescriptions": [ "Default value. This value is unused. When users create a ServingProfile, they must choose a scope.", "The scope for Gemini Live.", "The scope for Interactions API.", -"The scope for Response API." +"The scope for Response API.", +"The scope for Voices API." ], "type": "string" }, @@ -103219,7 +103858,7 @@ false "type": "string" }, "path": { -"description": "Output only. Absolute path in the task's sandbox, e.g. \"/workspace/userdata/input.csv\" or \"/workspace/report.md\". Always under \"/workspace\" and never contains \"..\". Can be passed as-is to DownloadTaskArtifact.", +"description": "Output only. Absolute path in the task's sandbox, e.g. \"/workspace/userdata/input.csv\" or \"/workspace/report.md\". Always under \"/workspace\" and never contains \"..\". Can be passed as-is to ArtifactService.DownloadArtifact.", "readOnly": true, "type": "string" }, @@ -103534,7 +104173,7 @@ false "description": "Optional. Immutable. Session-level HITL (human-in-the-loop) configuration for this task. Unset means every HITL knob takes its default; see `HitlConfig` above for the individual field defaults." }, "inputs": { -"description": "Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. UploadTaskArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace.", +"description": "Optional. The prompt expressed as Interaction steps (e.g. a ContentStep with the user's request). Reuses the Interactions step model so the same content flows into the runtime unchanged. Required for a scheduled or PRIORITY_DEFERRED task, which starts with no caller attached. Otherwise it may be empty: * Unary CreateTask with no inputs creates the task IDLE and dispatches nothing. The task starts when a caller subscribes to it on CreateTaskBidiStream (`subscribe_task`) and sends the first input. * CreateTaskBidiStream `create_task` with no inputs is a connect-only / pre-warm create; the first input is sent later as a client step. Recommended pattern for giving a task files before it runs: 1. CreateTask with empty `inputs`. The task is IDLE; nothing runs yet. 2. ArtifactService.UploadArtifact each file to `/workspace/userdata/`. 3. CreateTaskBidiStream with `subscribe_task`, then send the first input, referring to the files by their `/workspace/userdata/` paths. This dispatches the task with the uploaded files in its workspace.", "items": { "$ref": "GenaiStep" }, @@ -106057,6 +106696,10 @@ false "readOnly": true, "type": "string" }, +"omniLoraTuningSpec": { +"$ref": "GoogleCloudAiplatformV1beta1OmniLoraTuningSpec", +"description": "Optional. Tuning Spec for Omni LoRA Tuning." +}, "outputUri": { "description": "Optional. Cloud Storage path to the directory where tuning job outputs are written to. This field is only available and required for open source models.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json index ccc795d7a2..cb6beaf469 100644 --- a/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json +++ b/googleapiclient/discovery_cache/documents/androiddeviceprovisioning.v1.json @@ -851,7 +851,7 @@ } } }, -"revision": "20260819", +"revision": "20261114", "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "schemas": { "ClaimDeviceRequest": { @@ -963,7 +963,8 @@ "readOnly": true }, "languageCode": { -"description": "Input only. The preferred locale of the customer represented as a BCP47 language code. This field is validated on input and requests containing unsupported language codes will be rejected. Supported language codes: Arabic (ar) Chinese (Hong Kong) (zh-HK) Chinese (Simplified) (zh-CN) Chinese (Traditional) (zh-TW) Czech (cs) Danish (da) Dutch (nl) English (UK) (en-GB) English (US) (en-US) Filipino (fil) Finnish (fi) French (fr) German (de) Hebrew (iw) Hindi (hi) Hungarian (hu) Indonesian (id) Italian (it) Japanese (ja) Korean (ko) Norwegian (Bokmal) (no) Polish (pl) Portuguese (Brazil) (pt-BR) Portuguese (Portugal) (pt-PT) Russian (ru) Spanish (es) Spanish (Latin America) (es-419) Swedish (sv) Thai (th) Turkish (tr) Ukrainian (uk) Vietnamese (vi)", +"deprecated": true, +"description": "Input only. Deprecated: This field is no longer supported and is ignored by the server.", "type": "string" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 132cc61f31..0d4ae238e2 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -1935,7 +1935,7 @@ "aiGeneratedStateAiGeneratedDeveloperAttested" ], "enumDescriptions": [ -"Catch-all for unrecognized enum values. See go/protodosdonts.", +"Unspecified AI generated state.", "The content is not generated by AI.", "The content is generated by AI and attested by the developer." ], @@ -5400,6 +5400,40 @@ "https://www.googleapis.com/auth/androidpublisher" ] }, +"cancelplantransition": { +"description": "Cancel a plan transition for a subscription.", +"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancelPlanTransition", +"httpMethod": "POST", +"id": "androidpublisher.purchases.subscriptionsv2.cancelplantransition", +"parameterOrder": [ +"packageName", +"token" +], +"parameters": { +"packageName": { +"description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').", +"location": "path", +"required": true, +"type": "string" +}, +"token": { +"description": "Required. The token provided to the user's device when the subscription was purchased.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:cancelPlanTransition", +"request": { +"$ref": "CancelPlanTransitionRequest" +}, +"response": { +"$ref": "CancelPlanTransitionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, "defer": { "description": "Defers the renewal of a subscription.", "flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:defer", @@ -5498,6 +5532,40 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] +}, +"scheduleplantransition": { +"description": "Schedule a plan transition for a subscription.", +"flatPath": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:schedulePlanTransition", +"httpMethod": "POST", +"id": "androidpublisher.purchases.subscriptionsv2.scheduleplantransition", +"parameterOrder": [ +"packageName", +"token" +], +"parameters": { +"packageName": { +"description": "Required. The package of the application for which this subscription was purchased (for example, 'com.some.thing').", +"location": "path", +"required": true, +"type": "string" +}, +"token": { +"description": "Required. The token provided to the user's device when the subscription was purchased.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/purchases/subscriptionsv2/tokens/{token}:schedulePlanTransition", +"request": { +"$ref": "SchedulePlanTransitionRequest" +}, +"response": { +"$ref": "SchedulePlanTransitionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] } } }, @@ -5970,7 +6038,7 @@ } } }, -"revision": "20261026", +"revision": "20261116", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6766,6 +6834,10 @@ "$ref": "InstallmentPlan", "description": "The installment plan commitment and state related info for the auto renewing plan." }, +"planTransitionDetails": { +"$ref": "PlanTransitionDetails", +"description": "The information of the associated plan transition. Will be present only if this plan has a transition plan associated with it and will only include the latest transition details associated with the item." +}, "priceChangeDetails": { "$ref": "SubscriptionItemPriceChangeDetails", "description": "The information of the last price change for the item since subscription signup." @@ -6841,6 +6913,10 @@ ], "readOnly": true, "type": "string" +}, +"transitionTargetConfig": { +"$ref": "TransitionTargetConfig", +"description": "Transition target base plan information when this base plan has a transition plan." } }, "type": "object" @@ -7348,6 +7424,27 @@ }, "type": "object" }, +"CancelPlanTransitionRequest": { +"description": "Request for the purchases.subscriptionsv2.cancelplantransition API.", +"id": "CancelPlanTransitionRequest", +"properties": { +"etag": { +"description": "If set, the API will fail if the etag does not match the latest etag for this subscription. The etag is retrieved from purchases.subscriptionsv2.get: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get", +"type": "string" +}, +"productId": { +"description": "Required. The subscription product (for example, 'premium_plan') for which an in process plan transition should be canceled.", +"type": "string" +} +}, +"type": "object" +}, +"CancelPlanTransitionResponse": { +"description": "Response for the purchases.subscriptionsv2.cancelplantransition API.", +"id": "CancelPlanTransitionResponse", +"properties": {}, +"type": "object" +}, "CancelSubscriptionPurchaseRequest": { "description": "Request for the purchases.subscriptionsv2.cancel API.", "id": "CancelSubscriptionPurchaseRequest", @@ -8166,6 +8263,12 @@ }, "type": "object" }, +"DefiniteTransition": { +"description": "Used to indicate that the plan transition is definite.", +"id": "DefiniteTransition", +"properties": {}, +"type": "object" +}, "DeleteOneTimeProductOfferRequest": { "description": "Request message for deleting an one-time product offer.", "id": "DeleteOneTimeProductOfferRequest", @@ -9517,7 +9620,7 @@ false "aiGeneratedStateAiGeneratedDeveloperAttested" ], "enumDescriptions": [ -"Catch-all for unrecognized enum values. See go/protodosdonts.", +"Unspecified AI generated state.", "The content is not generated by AI.", "The content is generated by AI and attested by the developer." ], @@ -9628,7 +9731,7 @@ false "additionalProperties": { "$ref": "Price" }, -"description": "Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-2.", +"description": "Prices per buyer region. None of these can be zero, as in-app products are never free. Map key is region code, as defined by ISO 3166-1 alpha-2.", "type": "object" }, "purchaseType": { @@ -10991,7 +11094,7 @@ true "description": "The price defined in the purchase option for this region will be used." }, "regionCode": { -"description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., \"US\".", +"description": "Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., \"US\".", "type": "string" }, "relativeDiscount": { @@ -11154,7 +11257,7 @@ true "description": "The price of the purchase option in the specified region. Must be set in the currency that is linked to the specified region." }, "regionCode": { -"description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g., \"US\".", +"description": "Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g., \"US\".", "type": "string" } }, @@ -11606,6 +11709,25 @@ true "properties": {}, "type": "object" }, +"PlanTransitionDetails": { +"description": "Information related to a plan transition.", +"id": "PlanTransitionDetails", +"properties": { +"basePlanId": { +"description": "[Required] The base plan ID to which this plan would be transitioned.", +"type": "string" +}, +"productId": { +"description": "[Required] The product ID to which this plan would be transitioned, (for example, 'monthly001').", +"type": "string" +}, +"transitionInfo": { +"$ref": "TransitionInfo", +"description": "Additional info about the scheduled plan transition. Will be present only if a plan transition has been scheduled." +} +}, +"type": "object" +}, "PointsDetails": { "description": "Details relating to any Play Points applied to an order.", "id": "PointsDetails", @@ -12359,7 +12481,7 @@ true "description": "The price of the base plan in the specified region. Must be set if the base plan is available to new subscribers. Must be set in the currency that is linked to the specified region." }, "regionCode": { -"description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "type": "string" } }, @@ -12389,7 +12511,7 @@ true "type": "string" }, "regionCode": { -"description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "type": "string" } }, @@ -12418,7 +12540,7 @@ true "type": "string" }, "regionCode": { -"description": "Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "type": "string" } }, @@ -12433,7 +12555,7 @@ true "type": "boolean" }, "regionCode": { -"description": "Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Required. Immutable. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "type": "string" } }, @@ -12482,7 +12604,7 @@ true "type": "boolean" }, "regionCode": { -"description": "Required. Region code this configuration applies to, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Required. Region code this configuration applies to, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "type": "string" }, "streamingTaxType": { @@ -12733,7 +12855,7 @@ true "id": "RestrictedPaymentCountries", "properties": { "regionCodes": { -"description": "Required. Region codes to impose payment restrictions on, as defined by ISO 3166-2, e.g. \"US\".", +"description": "Required. Region codes to impose payment restrictions on, as defined by ISO 3166-1 alpha-2, e.g. \"US\".", "items": { "type": "string" }, @@ -12957,6 +13079,45 @@ true "properties": {}, "type": "object" }, +"SchedulePlanTransitionRequest": { +"description": "Request for the purchases.subscriptionsv2.schedulePlanTransition API.", +"id": "SchedulePlanTransitionRequest", +"properties": { +"definiteTransition": { +"$ref": "DefiniteTransition", +"description": "When using this mode, the user's transition to the new plan is definite, and cannot be canceled." +}, +"earliestTransitionEffectiveTime": { +"description": "Required. The earliest time at which the plan transition may take effect. The actual transition will take place at the time of renewal on or after this time.", +"format": "google-datetime", +"type": "string" +}, +"etag": { +"description": "If set, the API will fail if the etag does not match the latest etag for this subscription. The etag is retrieved from purchases.subscriptionsv2.get: https://developers.google.com/android-publisher/api-ref/rest/v3/purchases.subscriptionsv2/get", +"type": "string" +}, +"productId": { +"description": "Required. The subscription product (for example, 'premium_plan') for which the transition must be scheduled.", +"type": "string" +}, +"tentativeTransition": { +"$ref": "TentativeTransition", +"description": "When using this mode, the user's transition to the new plan is tentative, and can be canceled." +} +}, +"type": "object" +}, +"SchedulePlanTransitionResponse": { +"description": "Response for the purchases.subscriptionsv2.schedulePlanTransition API.", +"id": "SchedulePlanTransitionResponse", +"properties": { +"planTransitionDetails": { +"$ref": "PlanTransitionDetails", +"description": "The plan transition details of the subscription item." +} +}, +"type": "object" +}, "ScreenDensity": { "description": "Represents a screen density.", "id": "ScreenDensity", @@ -13872,6 +14033,12 @@ true }, "type": "object" }, +"TentativeTransition": { +"description": "Used to indicate that the plan transition is tentative.", +"id": "TentativeTransition", +"properties": {}, +"type": "object" +}, "TestPurchase": { "description": "Whether this subscription purchase is a test purchase.", "id": "TestPurchase", @@ -14166,6 +14333,56 @@ true }, "type": "object" }, +"TransitionInfo": { +"description": "Information related to a scheduled plan transition.", +"id": "TransitionInfo", +"properties": { +"expectedTransitionTime": { +"description": "The current expected time at which the plan may be transitioned. This is subject to change (to a future time) due to cases where the renewal time shifts like pause and account hold.", +"format": "google-datetime", +"type": "string" +}, +"price": { +"$ref": "Money", +"description": "The default base plan price to which the plan will be transitioned." +}, +"transitionState": { +"description": "Output only. [Required] The current state of the transition.", +"enum": [ +"TRANSITION_STATE_UNSPECIFIED", +"SCHEDULED", +"IN_PROGRESS", +"COMPLETED", +"CANCELED" +], +"enumDescriptions": [ +"Unspecified transition state.", +"The transition is scheduled to start in the future.", +"The transition process has been initiated and the initial transition notification has been sent to the user.", +"The transition has been completed.", +"The transition was canceled." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TransitionTargetConfig": { +"description": "Configuration for a transition target base plan.", +"id": "TransitionTargetConfig", +"properties": { +"basePlanId": { +"description": "Required. The ID of the transition target base plan.", +"type": "string" +}, +"productId": { +"description": "Required. The ID of the parent subscription this transition target base plan belongs to.", +"type": "string" +} +}, +"type": "object" +}, "UpdateAppStoreHostedAppPublishStatusRequest": { "description": "Request to update the publish status of an app store hosted app. The default state for any app with an update is PUBLISHED. It is not necessary to call this RPC explicitly to set an app to PUBLISHED.", "id": "UpdateAppStoreHostedAppPublishStatusRequest", diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index af815dc146..f53c4884df 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -181,7 +181,7 @@ "keys": { "methods": { "create": { -"description": "Creates a new API key. NOTE: Key is a global resource; hence the only supported value for location is `global`.", +"description": "Creates a new API key. The key string of the API key is included in the response and can afterward only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys", "httpMethod": "POST", "id": "apikeys.projects.locations.keys.create", @@ -215,7 +215,7 @@ ] }, "delete": { -"description": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. NOTE: Key is a global resource; hence the only supported value for location is `global`.", +"description": "Deletes an API key. Deleted key can be retrieved within 30 days of deletion. Afterward, key will be purged from the project. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}", "httpMethod": "DELETE", "id": "apikeys.projects.locations.keys.delete", @@ -361,7 +361,7 @@ ] }, "patch": { -"description": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response. NOTE: Key is a global resource; hence the only supported value for location is `global`.", +"description": "Patches the modifiable fields of an API key. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}", "httpMethod": "PATCH", "id": "apikeys.projects.locations.keys.patch", @@ -411,7 +411,7 @@ ] }, "undelete": { -"description": "Undeletes an API key which was deleted within 30 days. NOTE: Key is a global resource; hence the only supported value for location is `global`.", +"description": "Undeletes an API key which was deleted within 30 days. The key string of the API key isn't included in the response and can only be retrieved through the `GetKeyString` method. NOTE: Key is a global resource; hence the only supported value for location is `global`.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/keys/{keysId}:undelete", "httpMethod": "POST", "id": "apikeys.projects.locations.keys.undelete", @@ -446,7 +446,7 @@ } } }, -"revision": "20260818", +"revision": "20261110", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { @@ -629,7 +629,7 @@ "type": "string" }, "keyString": { -"description": "Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method.", +"description": "Output only. An encrypted and signed value held by this key. This field is returned upon initial key creation (`CreateKey`) and can afterward be accessed only through the `GetKeyString` method.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 6df2d0dda9..8034a48d9b 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -2,6 +2,12 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/assuredworkloads": { +"description": "See, edit, configure, and delete your Google Cloud Assured Workloads data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/assuredworkloads.readonly": { +"description": "See your Google Cloud Assured Workloads data and the email address of your Google Account" +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } @@ -15,6 +21,23 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/learnmoreurl", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.ca.rep.googleapis.com/", +"location": "ca" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.eu.rep.googleapis.com/", +"location": "eu" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -105,1333 +128,638 @@ }, "protocol": "rest", "resources": { -"folders": { +"organizations": { "resources": { "locations": { "resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFindingSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/dbFindingSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"dbFrameworkComplianceReports": { +"operations": { "methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate", +"id": "assuredworkloads.organizations.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:aggregate", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] }, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch", +"id": "assuredworkloads.organizations.locations.operations.list", "parameterOrder": [ "name" ], "parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, "filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"description": "The standard list filter.", "location": "query", "type": "string" }, "name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" -} -}, -"path": "v1/{+name}:fetch", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"dbControlComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", -"location": "query", -"type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "The standard list page token.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, -"path": "v1/{+parent}/dbControlComplianceSummaries", +"path": "v1/{+name}/operations", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] } } -} -} }, -"dbFrameworkComplianceSummaries": { +"workloads": { "methods": { -"list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"analyzeWorkloadMove": { +"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list", +"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", "parameterOrder": [ -"parent" +"target" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"assetTypes": { +"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "location": "query", +"repeated": true, "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+$", -"required": true, +"project": { +"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", +"location": "query", "type": "string" }, -"view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", -"enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." -], -"location": "query", +"target": { +"description": "Required. The resource name of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1/{+parent}/dbFrameworkComplianceSummaries", +"path": "v1/{+target}:analyzeWorkloadMove", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} -} }, -"organizations": { -"resources": { -"locations": { -"resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFindingSummaries.list", +"create": { +"description": "Creates Assured Workload.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.create", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"externalId": { +"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/dbFindingSummaries", +"path": "v1/{+parent}/workloads", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1Workload" +}, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"dbFrameworkComplianceReports": { -"methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate", +"delete": { +"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "DELETE", +"id": "assuredworkloads.organizations.locations.workloads.delete", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", +"etag": { +"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", "location": "query", "type": "string" }, "name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:aggregate", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch", +"enableComplianceUpdates": { +"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", +"httpMethod": "PUT", +"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", "parameterOrder": [ "name" ], "parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:fetch", +"path": "v1/{+name}:enableComplianceUpdates", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" +"$ref": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"dbControlComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"enableResourceMonitoring": { +"description": "Enable resource violation monitoring for a workload.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"name": { +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/dbControlComplianceSummaries", +"path": "v1/{+name}:enableResourceMonitoring", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} +}, +"get": { +"description": "Gets Assured Workload associated with a CRM Node", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" } }, -"dbFrameworkComplianceSummaries": { -"methods": { +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1Workload" +}, +"scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"description": "Lists Assured Workloads under a CRM Node.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list", +"id": "assuredworkloads.organizations.locations.workloads.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"description": "Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. Page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", -"enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." -], -"location": "query", -"type": "string" } }, -"path": "v1/{+parent}/dbFrameworkComplianceSummaries", +"path": "v1/{+parent}/workloads", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"operations": { -"methods": { -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.get", +"mutatePartnerPermissions": { +"description": "Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions", +"httpMethod": "PATCH", +"id": "assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+name}:mutatePartnerPermissions", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/operations", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.list", +"patch": { +"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "PATCH", +"id": "assuredworkloads.organizations.locations.workloads.patch", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", +"updateMask": { +"description": "Required. The list of fields to be updated.", +"format": "google-fieldmask", "location": "query", "type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" } }, -"path": "v1/{+name}/operations", +"path": "v1/{+name}", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1Workload" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1Workload" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"workloads": { -"methods": { -"analyzeWorkloadMove": { -"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", +"restrictAllowedResources": { +"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", "parameterOrder": [ -"target" +"name" ], "parameters": { -"assetTypes": { -"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", -"location": "query", -"repeated": true, -"type": "string" -}, -"pageSize": { -"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", -"location": "query", -"type": "string" -}, -"project": { -"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", -"location": "query", -"type": "string" -}, -"target": { -"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", +"name": { +"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+target}:analyzeWorkloadMove", +"path": "v1/{+name}:restrictAllowedResources", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest" +}, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse" +"$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] +} }, -"create": { -"description": "Creates Assured Workload.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"resources": { +"updates": { +"methods": { +"apply": { +"description": "This endpoint creates a new operation to apply the given update.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", "httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.create", +"id": "assuredworkloads.organizations.locations.workloads.updates.apply", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"externalId": { -"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", +"name": { +"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/workloads", +"path": "v1/{+name}:apply", "request": { -"$ref": "GoogleCloudAssuredworkloadsV1Workload" +"$ref": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest" }, "response": { "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "DELETE", -"id": "assuredworkloads.organizations.locations.workloads.delete", +"list": { +"description": "This endpoint lists all updates for the given workload.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.updates.list", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"etag": { -"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", +"pageSize": { +"description": "Page size. The default value is 20 and the max allowed value is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Page token returned from previous request.", "location": "query", "type": "string" }, -"name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"parent": { +"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/updates", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"enableComplianceUpdates": { -"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", -"httpMethod": "PUT", -"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", +"violations": { +"methods": { +"acknowledge": { +"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"description": "Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}:enableComplianceUpdates", +"path": "v1/{+name}:acknowledge", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest" +}, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1EnableComplianceUpdatesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"enableResourceMonitoring": { -"description": "Enable resource violation monitoring for a workload.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", +"get": { +"description": "Retrieves an Assured Workloads violation by its resource name.", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"description": "Required. The resource name of the violation to retrieve (that is, the value of `Violation.name`). Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:enableResourceMonitoring", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1EnableResourceMonitoringResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets Assured Workload associated with a CRM Node", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists Assured Workloads under a CRM Node.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/workloads", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"mutatePartnerPermissions": { -"description": "Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:mutatePartnerPermissions", -"httpMethod": "PATCH", -"id": "assuredworkloads.organizations.locations.workloads.mutatePartnerPermissions", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:mutatePartnerPermissions", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1MutatePartnerPermissionsRequest" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "PATCH", -"id": "assuredworkloads.organizations.locations.workloads.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The list of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1Workload" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"restrictAllowedResources": { -"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:restrictAllowedResources", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesRequest" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1RestrictAllowedResourcesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"updates": { -"methods": { -"apply": { -"description": "This endpoint creates a new operation to apply the given update.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.updates.apply", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:apply", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "This endpoint lists all updates for the given workload.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.updates.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Page size. The default value is 20 and the max allowed value is 100.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Page token returned from previous request.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/updates", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListWorkloadUpdatesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"violations": { -"methods": { -"acknowledge": { -"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:acknowledge", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1AcknowledgeViolationResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Retrieves an Assured Workloads violation by its resource name.", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the violation to retrieve (that is, the value of `Violation.name`). Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", -"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}", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1Violation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", -"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `associatedOrgPolicyViolationId`, `cloudControlName`, `workloadDisplayName`, and `complianceType` (a framework ID). Example: `state = \"UNRESOLVED\" AND complianceType = \"builtin-fedramp-high\"`", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "The end of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "The start of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListViolations` call. Provide this token to retrieve the subsequent page. When paginating, all other parameters that are provided to `ListViolations` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The workload to list violations for. To list violations across all workloads in an organization, use `-` as the workload ID. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, violations are listed for the entire organization and location, and the workload ID is ignored. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", -"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", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListViolationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -} -} -} -} -}, -"projects": { -"resources": { -"locations": { -"resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFindingSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/dbFindingSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"dbFrameworkComplianceReports": { -"methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate", -"parameterOrder": [ -"name" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" -} -}, -"path": "v1/{+name}:aggregate", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] }, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch", -"parameterOrder": [ -"name" +"view": { +"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", +"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." ], -"parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", "location": "query", "type": "string" -}, -"name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" } }, -"path": "v1/{+name}:fetch", +"path": "v1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse" +"$ref": "GoogleCloudAssuredworkloadsV1Violation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"dbControlComplianceSummaries": { -"methods": { "list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", +"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", +"flatPath": "v1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", "httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"id": "assuredworkloads.organizations.locations.workloads.violations.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", +"description": "Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `associatedOrgPolicyViolationId`, `cloudControlName`, `workloadDisplayName`, and `complianceType` (a framework ID). Example: `state = \"UNRESOLVED\" AND complianceType = \"builtin-fedramp-high\"`", "location": "query", "type": "string" }, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"interval.endTime": { +"description": "The end of the time window.", +"format": "google-datetime", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, +"interval.startTime": { +"description": "The start of the time window.", +"format": "google-datetime", +"location": "query", "type": "string" -} -}, -"path": "v1/{+parent}/dbControlComplianceSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} }, -"dbFrameworkComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"orderBy": { +"description": "Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. A page token, received from a previous `ListViolations` call. Provide this token to retrieve the subsequent page. When paginating, all other parameters that are provided to `ListViolations` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. The workload to list violations for. To list violations across all workloads in an organization, use `-` as the workload ID. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, violations are listed for the entire organization and location, and the workload ID is ignored. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" }, "view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", +"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", "enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" ], "enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +"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}/dbFrameworkComplianceSummaries", +"path": "v1/{+parent}/violations", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1ListViolationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1441,8 +769,10 @@ } } } +} +} }, -"revision": "20261026", +"revision": "20261106", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1495,36 +825,6 @@ "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse": { -"description": "The response message for AggregateDbFrameworkComplianceReport.", -"id": "GoogleCloudAssuredworkloadsV1AggregateDbFrameworkComplianceReportResponse", -"properties": { -"aggregatedComplianceReports": { -"description": "The daily compliance reports for the requested time range.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1AggregatedComplianceReport": { -"description": "A point-in-time compliance report for a framework.", -"id": "GoogleCloudAssuredworkloadsV1AggregatedComplianceReport", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework at `report_time`." -}, -"reportTime": { -"description": "The time that the compliance report represents.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse": { "description": "Response containing the analysis results for the hypothetical resource move.", "id": "GoogleCloudAssuredworkloadsV1AnalyzeWorkloadMoveResponse", @@ -1581,278 +881,45 @@ "enum": [ "WORKLOAD_UPDATE_ACTION_UNSPECIFIED", "APPLY" -], -"enumDescriptions": [ -"Unspecified value.", -"The update is applied." -], -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse": { -"description": "Response for ApplyWorkloadUpdate endpoint.", -"id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse", -"properties": { -"appliedUpdate": { -"$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate", -"description": "The update that was applied." -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1AssetMoveAnalysis": { -"description": "Represents move analysis results for an asset.", -"id": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis", -"properties": { -"analysisGroups": { -"description": "List of eligible analyses performed for the asset.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup" -}, -"type": "array" -}, -"asset": { -"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", -"type": "string" -}, -"assetType": { -"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1CELExpression": { -"description": "A Common Expression Language (CEL) expression that's used to create a rule.", -"id": "GoogleCloudAssuredworkloadsV1CELExpression", -"properties": { -"expression": { -"description": "Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).", -"type": "string" -}, -"resourceTypesValues": { -"$ref": "GoogleCloudAssuredworkloadsV1StringList", -"description": "The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails": { -"description": "The cloud control assessment details for non-manual cloud controls.", -"id": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails", -"properties": { -"evaluationState": { -"description": "Output only. The evaluation status of the cloud control.", -"enum": [ -"EVALUATION_STATE_UNSPECIFIED", -"EVALUATION_STATE_PASSED", -"EVALUATION_STATE_FAILED", -"EVALUATION_STATE_NOT_ASSESSED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The control is passing.", -"The control is failing.", -"The control is not assessed." -], -"readOnly": true, -"type": "string" -}, -"findingsCount": { -"description": "The number of findings for the cloud control.", -"format": "int32", -"type": "integer" -}, -"orgPolicyFindingCount": { -"description": "Output only. Number of organization policy findings for the cloud control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"resourceFindingCount": { -"description": "Output only. Number of resource findings for the cloud control.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1CloudControlReport": { -"description": "The cloud control report.", -"id": "GoogleCloudAssuredworkloadsV1CloudControlReport", -"properties": { -"categories": { -"description": "The list of categories for the cloud control.", -"items": { -"type": "string" -}, -"type": "array" -}, -"cloudControl": { -"description": "The name of the cloud control.", -"type": "string" -}, -"cloudControlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1CloudControlAssessmentDetails", -"description": "The details of a cloud control assessment." -}, -"cloudControlDeployment": { -"description": "The name of the cloud control deployment.", -"type": "string" -}, -"cloudControlType": { -"description": "The type of the cloud control.", -"enum": [ -"TYPE_UNSPECIFIED", -"CUSTOM", -"BUILT_IN" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A cloud control that's created and managed by you.", -"A cloud control that's provided and managed by Google." -], -"type": "string" -}, -"description": { -"description": "The description of the cloud control.", -"type": "string" -}, -"displayName": { -"description": "The display name of the cloud control.", -"type": "string" -}, -"enforcementMode": { -"description": "The enforcement mode of the cloud control.", -"enum": [ -"ENFORCEMENT_MODE_UNSPECIFIED", -"PREVENTIVE", -"DETECTIVE", -"AUDIT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The cloud control is enforced to prevent non-compliance.", -"The cloud control is enforced to detect non-compliance.", -"The cloud control is enforced to audit for non-compliance." -], -"type": "string" -}, -"findingCategory": { -"description": "The category of the finding.", -"type": "string" -}, -"findingSeverity": { -"description": "The severity of the finding.", -"enum": [ -"SEVERITY_UNSPECIFIED", -"CRITICAL", -"HIGH", -"MEDIUM", -"LOW" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", -"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", -"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", -"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." -], -"type": "string" -}, -"frameworkMajorRevisionIds": { -"description": "The major revision IDs of the frameworks that the cloud control belongs to.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"majorRevisionId": { -"description": "The major revision ID of the cloud control.", -"format": "int64", -"type": "string" -}, -"manualCloudControlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails", -"description": "The details of a manual cloud control assessment." -}, -"minorRevisionId": { -"description": "The minor revision ID of the cloud control.", -"format": "int64", -"type": "string" -}, -"rules": { -"description": "The list of rules that correspond to the cloud control.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1Rule" -}, -"type": "array" -}, -"similarControls": { -"description": "The list of similar controls.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" -}, -"type": "array" +], +"enumDescriptions": [ +"Unspecified value.", +"The update is applied." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1ControlAssessmentDetails": { -"description": "The details for a control assessment.", -"id": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", +"GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse": { +"description": "Response for ApplyWorkloadUpdate endpoint.", +"id": "GoogleCloudAssuredworkloadsV1ApplyWorkloadUpdateResponse", "properties": { -"assessedPassingControlIds": { -"description": "The list of controls that were assessed and are passing.", -"items": { -"type": "string" -}, -"type": "array" +"appliedUpdate": { +"$ref": "GoogleCloudAssuredworkloadsV1WorkloadUpdate", +"description": "The update that was applied." +} }, -"assessedPassingControls": { -"description": "The number of controls that were assessed and are passing.", -"format": "int32", -"type": "integer" +"type": "object" }, -"failingControlIds": { -"description": "The list of controls that are failing.", +"GoogleCloudAssuredworkloadsV1AssetMoveAnalysis": { +"description": "Represents move analysis results for an asset.", +"id": "GoogleCloudAssuredworkloadsV1AssetMoveAnalysis", +"properties": { +"analysisGroups": { +"description": "List of eligible analyses performed for the asset.", "items": { -"type": "string" +"$ref": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup" }, "type": "array" }, -"failingControls": { -"description": "The number of controls that are failing.", -"format": "int32", -"type": "integer" -}, -"notAssessedControlIds": { -"description": "The list of controls that aren't assessed because they require manual review.", -"items": { +"asset": { +"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", "type": "string" }, -"type": "array" -}, -"notAssessedControls": { -"description": "The number of controls that aren't assessed because they require manual review.", -"format": "int32", -"type": "integer" -}, -"passingControlIds": { -"description": "The list of controls that are passing or not assessed.", -"items": { +"assetType": { +"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "type": "string" -}, -"type": "array" -}, -"passingControls": { -"description": "The number of controls that are passing or not assessed.", -"format": "int32", -"type": "integer" } }, "type": "object" @@ -1938,389 +1005,89 @@ false, false, false, false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"The default value. This value is used if the control package is omitted or unknown.", -"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", -"Australia Data Boundary and Support", -"Canada Data Boundary and Support", -"Data Boundary for Canada Controlled Goods", -"Data Boundary for Canada Protected B", -"Data Boundary for Criminal Justice Information Systems (CJIS)", -"Data Boundary for FedRAMP High", -"Data Boundary for FedRAMP Moderate", -"Data Boundary for Impact Level 2 (IL2)", -"Data Boundary for Impact Level 4 (IL4)", -"Data Boundary for Impact Level 5 (IL5)", -"Data Boundary for IRS Publication 1075", -"Data Boundary for International Traffic in Arms Regulations (ITAR)", -"European Union (EU) Data Boundary and Support", -"Israel Data Boundary and Support", -"Japan Data Boundary", -"Switzerland Data Boundary with Access Justifications", -"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", -"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", -"United States (US) Data Boundary and Support", -"United States (US) Data Boundary for Healthcare and Life Sciences", -"United States (US) Data Boundary for Healthcare and Life Sciences with Support", -"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." -], -"type": "string" -}, -"createTime": { -"description": "Optional. Time when the operation was created.", -"format": "google-datetime", -"type": "string" -}, -"displayName": { -"description": "Optional. The display name of the workload.", -"type": "string" -}, -"parent": { -"description": "Optional. The parent of the workload.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1DbControlComplianceSummary": { -"description": "A summary of the compliance status of a control in a framework compliance report.", -"id": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary", -"properties": { -"cloudControlReports": { -"description": "The list of cloud control reports.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1CloudControlReport" -}, -"type": "array" -}, -"complianceFrameworks": { -"description": "The list of compliance frameworks that the control belongs to.", -"items": { -"type": "string" -}, -"type": "array" -}, -"control": { -"description": "The name of the control.", -"type": "string" -}, -"controlResponsibilityType": { -"description": "The responsibility type for the control.", -"enum": [ -"REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED", -"GOOGLE", -"CUSTOMER", -"SHARED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Google's responsibility.", -"Your responsibility.", -"Shared responsibility." -], -"type": "string" -}, -"description": { -"description": "The description of the control.", -"type": "string" -}, -"displayName": { -"description": "The display name of the control.", -"type": "string" -}, -"isFakeControl": { -"description": "Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.", -"type": "boolean" -}, -"name": { -"description": "Identifier. The resource name of the control compliance summary. Format: `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}/dbControlComplianceSummaries/{db_control_compliance_summary}`", -"type": "string" -}, -"orgPolicyFindingCount": { -"description": "Output only. Number of organization policy findings for this control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"overallEvaluationState": { -"description": "Output only. The overall evaluation status of the control.", -"enum": [ -"EVALUATION_STATE_UNSPECIFIED", -"EVALUATION_STATE_PASSED", -"EVALUATION_STATE_FAILED", -"EVALUATION_STATE_NOT_ASSESSED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The control is passing.", -"The control is failing.", -"The control is not assessed." -], -"readOnly": true, -"type": "string" -}, -"resourceFindingCount": { -"description": "Output only. Number of resource findings for this control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"similarControls": { -"description": "The list of similar controls.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1SimilarControls" -}, -"type": "array" -}, -"totalFindingsCount": { -"description": "The total number of findings for the control.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1DbFindingSummary": { -"description": "A summary of the active findings for a finding category in a Data Boundary scope.", -"id": "GoogleCloudAssuredworkloadsV1DbFindingSummary", -"properties": { -"findingCategory": { -"description": "Output only. The category of the findings that are summarized.", -"readOnly": true, -"type": "string" -}, -"findingClass": { -"description": "Output only. The class of the findings.", -"enum": [ -"FINDING_CLASS_UNSPECIFIED", -"THREAT", -"VULNERABILITY", -"MISCONFIGURATION", -"OBSERVATION", -"SCC_ERROR", -"POSTURE_VIOLATION", -"TOXIC_COMBINATION", -"SENSITIVE_DATA_RISK", -"CHOKEPOINT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The activity is unwanted or malicious.", -"A potential weakness in software that increases risk to confidentiality, integrity, and availability.", -"A potential weakness in a cloud resource or asset configuration that increases risk.", -"A security observation that is for informational purposes.", -"An error that prevents Security Command Center from functioning properly.", -"A potential security risk that's due to a change in the security posture.", -"A combination of security issues that represent a more severe security problem when taken together.", -"A potential security risk to data assets that contain sensitive data.", -"A resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." -], -"readOnly": true, -"type": "string" -}, -"findingCount": { -"description": "Output only. The total number of active findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Identifier. The resource name of the finding summary.", -"type": "string" -}, -"organizationPolicyFindingCount": { -"description": "Output only. The number of active organization policy findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"relatedFrameworks": { -"description": "Optional. The display names of the compliance frameworks that the findings are related to.", -"items": { -"type": "string" -}, -"type": "array" -}, -"resourceFindingCount": { -"description": "Output only. The number of active resource findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"severity": { -"description": "Output only. The severity of the findings.", -"enum": [ -"SEVERITY_UNSPECIFIED", -"CRITICAL", -"HIGH", -"MEDIUM", -"LOW" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", -"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", -"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", -"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." -], -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time when the findings in the category were last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary": { -"description": "A summary of the compliance status of a framework that's deployed in a Data Boundary scope.", -"id": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework." -}, -"controlsPassingTrend": { -"$ref": "GoogleCloudAssuredworkloadsV1Trend", -"description": "Output only. The trend of passing controls over the trend duration. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.", -"readOnly": true -}, -"findingCount": { -"description": "Output only. The number of findings that were generated against the framework. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"framework": { -"description": "The resource name of the compliance framework.", -"type": "string" -}, -"frameworkCategories": { -"description": "The categories of the framework.", -"items": { -"enum": [ -"FRAMEWORK_CATEGORY_UNSPECIFIED", -"INDUSTRY_DEFINED_STANDARD", -"ASSURED_WORKLOADS", -"DATA_SECURITY", -"GOOGLE_BEST_PRACTICES", -"CUSTOM_FRAMEWORK" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"An industry-defined framework.", -"An Assured Workloads framework.", -"A data security posture framework.", -"A Google's best practices framework.", -"A user-created framework." -], -"type": "string" -}, -"type": "array" -}, -"frameworkDisplayName": { -"description": "Optional. The display name of the framework.", -"type": "string" -}, -"frameworkType": { -"description": "The type of the framework.", -"enum": [ -"FRAMEWORK_TYPE_UNSPECIFIED", -"BUILT_IN", -"CUSTOM" +false, +false, +false, +false, +false, +false, +false, +true, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false ], "enumDescriptions": [ -"Default value. This value is unused.", -"A framework that's provided and managed by Google.", -"A framework that's created and managed by you." +"The default value. This value is used if the control package is omitted or unknown.", +"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", +"Australia Data Boundary and Support", +"Canada Data Boundary and Support", +"Data Boundary for Canada Controlled Goods", +"Data Boundary for Canada Protected B", +"Data Boundary for Criminal Justice Information Systems (CJIS)", +"Data Boundary for FedRAMP High", +"Data Boundary for FedRAMP Moderate", +"Data Boundary for Impact Level 2 (IL2)", +"Data Boundary for Impact Level 4 (IL4)", +"Data Boundary for Impact Level 5 (IL5)", +"Data Boundary for IRS Publication 1075", +"Data Boundary for International Traffic in Arms Regulations (ITAR)", +"European Union (EU) Data Boundary and Support", +"Israel Data Boundary and Support", +"Japan Data Boundary", +"Switzerland Data Boundary with Access Justifications", +"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", +"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", +"United States (US) Data Boundary and Support", +"United States (US) Data Boundary for Healthcare and Life Sciences", +"United States (US) Data Boundary for Healthcare and Life Sciences with Support", +"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." ], "type": "string" }, -"majorRevisionId": { -"description": "The major revision ID of the framework.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The minor revision ID of the framework.", -"format": "int64", +"createTime": { +"description": "Optional. Time when the operation was created.", +"format": "google-datetime", "type": "string" }, -"name": { -"description": "Identifier. The resource name of the framework compliance summary.", +"displayName": { +"description": "Optional. The display name of the workload.", "type": "string" }, -"supportedCloudProviders": { -"description": "The cloud providers that are supported by the framework.", -"items": { -"enum": [ -"CLOUD_PROVIDER_UNSPECIFIED", -"AWS", -"AZURE", -"GCP" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Amazon Web Services (AWS).", -"Microsoft Azure.", -"Google Cloud." -], +"parent": { +"description": "Optional. The parent of the workload.", "type": "string" -}, -"type": "array" -}, -"targetResourceDetails": { -"description": "The details of the target resources (organizations, folders, or projects) that the framework is deployed on.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" -}, -"type": "array" } }, "type": "object" @@ -2337,169 +1104,6 @@ false "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse": { -"description": "The response message for FetchDbFrameworkComplianceReport.", -"id": "GoogleCloudAssuredworkloadsV1FetchDbFrameworkComplianceReportResponse", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework." -}, -"framework": { -"description": "The resource name of the compliance framework. For example, `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.", -"type": "string" -}, -"frameworkCategories": { -"description": "The categories of the framework.", -"items": { -"enum": [ -"FRAMEWORK_CATEGORY_UNSPECIFIED", -"INDUSTRY_DEFINED_STANDARD", -"ASSURED_WORKLOADS", -"DATA_SECURITY", -"GOOGLE_BEST_PRACTICES", -"CUSTOM_FRAMEWORK" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"An industry-defined framework.", -"An Assured Workloads framework.", -"A data security posture framework.", -"A Google's best practices framework.", -"A user-created framework." -], -"type": "string" -}, -"type": "array" -}, -"frameworkDescription": { -"description": "The description of the framework.", -"type": "string" -}, -"frameworkDisplayName": { -"description": "Optional. The display name of the framework.", -"type": "string" -}, -"frameworkType": { -"description": "The type of the framework.", -"enum": [ -"FRAMEWORK_TYPE_UNSPECIFIED", -"BUILT_IN", -"CUSTOM" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A framework that's provided and managed by Google.", -"A framework that's created and managed by you." -], -"type": "string" -}, -"majorRevisionId": { -"description": "The latest major revision ID of the framework.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The latest minor revision ID of the latest major revision of the framework.", -"format": "int64", -"type": "string" -}, -"name": { -"description": "The resource name of the framework compliance report.", -"type": "string" -}, -"supportedCloudProviders": { -"description": "The cloud providers that are supported by the framework.", -"items": { -"enum": [ -"CLOUD_PROVIDER_UNSPECIFIED", -"AWS", -"AZURE", -"GCP" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Amazon Web Services (AWS).", -"Microsoft Azure.", -"Google Cloud." -], -"type": "string" -}, -"type": "array" -}, -"targetResourceDetails": { -"description": "The details of the target resources (organizations, folders, or projects) that the framework is deployed on.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1TargetResourceDetails" -}, -"type": "array" -}, -"updateTime": { -"description": "Output only. The time when the report was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse": { -"description": "The response message for ListDbControlComplianceSummaries.", -"id": "GoogleCloudAssuredworkloadsV1ListDbControlComplianceSummariesResponse", -"properties": { -"dbControlComplianceSummaries": { -"description": "The list of control compliance summaries.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1DbControlComplianceSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse": { -"description": "The response message for ListDbFindingSummaries.", -"id": "GoogleCloudAssuredworkloadsV1ListDbFindingSummariesResponse", -"properties": { -"dbFindingSummaries": { -"description": "The list of finding summaries, one for each finding category.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1DbFindingSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse": { -"description": "The response message for ListDbFrameworkComplianceSummaries.", -"id": "GoogleCloudAssuredworkloadsV1ListDbFrameworkComplianceSummariesResponse", -"properties": { -"dbFrameworkComplianceSummaries": { -"description": "The list of framework compliance summaries.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1DbFrameworkComplianceSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1ListViolationsResponse": { "description": "Response message for the `ListViolations` method.", "id": "GoogleCloudAssuredworkloadsV1ListViolationsResponse", @@ -2559,20 +1163,6 @@ false }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails": { -"description": "The details for a manual cloud control assessment.", -"id": "GoogleCloudAssuredworkloadsV1ManualCloudControlAssessmentDetails", -"properties": { -"manualCloudControlGuide": { -"description": "The guide for assessing a cloud control manually.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup": { "description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.", "id": "GoogleCloudAssuredworkloadsV1MoveAnalysisGroup", @@ -2759,127 +1349,6 @@ false "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1Rule": { -"description": "A rule in the cloud control.", -"id": "GoogleCloudAssuredworkloadsV1Rule", -"properties": { -"celExpression": { -"$ref": "GoogleCloudAssuredworkloadsV1CELExpression", -"description": "The rule's logic expression in Common Expression Language (CEL)." -}, -"description": { -"description": "Optional. The rule description. The maximum length is 2000 characters.", -"type": "string" -}, -"ruleActionTypes": { -"description": "Required. The functionality that's enabled by the rule.", -"items": { -"enum": [ -"RULE_ACTION_TYPE_UNSPECIFIED", -"RULE_ACTION_TYPE_PREVENTIVE", -"RULE_ACTION_TYPE_DETECTIVE", -"RULE_ACTION_TYPE_AUDIT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The rule is intended to prevent non-compliance.", -"The rule is intended to detect non-compliance.", -"The rule is intended to audit non-compliance." -], -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1SimilarControls": { -"description": "The similar controls.", -"id": "GoogleCloudAssuredworkloadsV1SimilarControls", -"properties": { -"controlId": { -"description": "The ID of the control.", -"type": "string" -}, -"framework": { -"description": "The name of the framework.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1StringList": { -"description": "A list of strings for the parameter value.", -"id": "GoogleCloudAssuredworkloadsV1StringList", -"properties": { -"values": { -"description": "Required. The strings in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1TargetResourceDetails": { -"description": "The details for a target resource.", -"id": "GoogleCloudAssuredworkloadsV1TargetResourceDetails", -"properties": { -"createTime": { -"description": "The create time of the target resource.", -"format": "google-datetime", -"type": "string" -}, -"frameworkDeployment": { -"description": "The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`", -"type": "string" -}, -"majorRevisionId": { -"description": "The major revision ID of the framework for the target resource.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The minor revision ID of the framework for the target resource.", -"format": "int64", -"type": "string" -}, -"targetResource": { -"description": "The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.", -"type": "string" -}, -"targetResourceDisplayName": { -"description": "The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.", -"type": "string" -}, -"updateTime": { -"description": "The update time of the target resource.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1Trend": { -"description": "The trend of a compliance metric.", -"id": "GoogleCloudAssuredworkloadsV1Trend", -"properties": { -"duration": { -"description": "Output only. The duration for the trend.", -"format": "google-duration", -"readOnly": true, -"type": "string" -}, -"valuePercent": { -"description": "Output only. The trend value as a percentage. The value can be positive or negative.", -"format": "double", -"readOnly": true, -"type": "number" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1UpdateDetails": { "description": "The details of the update.", "id": "GoogleCloudAssuredworkloadsV1UpdateDetails", diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index c7574fd4da..2cbfff6f11 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -2,6 +2,12 @@ "auth": { "oauth2": { "scopes": { +"https://www.googleapis.com/auth/assuredworkloads": { +"description": "See, edit, configure, and delete your Google Cloud Assured Workloads data and see the email address for your Google Account" +}, +"https://www.googleapis.com/auth/assuredworkloads.readonly": { +"description": "See your Google Cloud Assured Workloads data and the email address of your Google Account" +}, "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } @@ -15,6 +21,23 @@ "description": "", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/learnmoreurl", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.us.rep.googleapis.com/", +"location": "us" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.ca.rep.googleapis.com/", +"location": "ca" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://assuredworkloads.eu.rep.googleapis.com/", +"location": "eu" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -105,1305 +128,609 @@ }, "protocol": "rest", "resources": { -"folders": { +"organizations": { "resources": { "locations": { "resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFindingSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/dbFindingSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"dbFrameworkComplianceReports": { +"operations": { "methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.aggregate", +"id": "assuredworkloads.organizations.locations.operations.get", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "The name of the operation resource.", "location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:aggregate", +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] }, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.fetch", +"id": "assuredworkloads.organizations.locations.operations.list", "parameterOrder": [ "name" ], "parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, "filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"description": "The standard list filter.", "location": "query", "type": "string" }, "name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "The name of the operation's parent resource.", "location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" -} -}, -"path": "v1beta1/{+name}:fetch", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"dbControlComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", -"location": "query", -"type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "The standard list page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "The standard list page token.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" +"returnPartialSuccess": { +"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", +"location": "query", +"type": "boolean" } }, -"path": "v1beta1/{+parent}/dbControlComplianceSummaries", +"path": "v1beta1/{+name}/operations", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" +"$ref": "GoogleLongrunningListOperationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] } } -} -} }, -"dbFrameworkComplianceSummaries": { +"workloads": { "methods": { -"list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1beta1/folders/{foldersId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"analyzeWorkloadMove": { +"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", "httpMethod": "GET", -"id": "assuredworkloads.folders.locations.dbFrameworkComplianceSummaries.list", +"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", "parameterOrder": [ -"parent" +"target" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"assetTypes": { +"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "location": "query", +"repeated": true, "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^folders/[^/]+/locations/[^/]+$", -"required": true, +"project": { +"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", +"location": "query", "type": "string" }, -"view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", -"enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." -], -"location": "query", +"target": { +"description": "Required. The resource name of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/dbFrameworkComplianceSummaries", +"path": "v1beta1/{+target}:analyzeWorkloadMove", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} -} }, -"organizations": { -"resources": { -"locations": { -"resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFindingSummaries.list", +"create": { +"description": "Creates Assured Workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.create", "parameterOrder": [ "parent" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"externalId": { +"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/dbFindingSummaries", +"path": "v1beta1/{+parent}/workloads", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" +"$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"dbFrameworkComplianceReports": { -"methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.aggregate", +"delete": { +"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "DELETE", +"id": "assuredworkloads.organizations.locations.workloads.delete", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", +"etag": { +"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", "location": "query", "type": "string" }, "name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:aggregate", +"path": "v1beta1/{+name}", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" +"$ref": "GoogleProtobufEmpty" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.fetch", +"enableComplianceUpdates": { +"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", +"httpMethod": "PUT", +"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", "parameterOrder": [ "name" ], "parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+name}:fetch", +"path": "v1beta1/{+name}:enableComplianceUpdates", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} }, -"resources": { -"dbControlComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", +"enableResourceMonitoring": { +"description": "Enable resource violation monitoring for a workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", +"name": { +"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/dbControlComplianceSummaries", +"path": "v1beta1/{+name}:enableResourceMonitoring", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} +}, +"get": { +"description": "Gets Assured Workload associated with a CRM Node", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"required": true, +"type": "string" } }, -"dbFrameworkComplianceSummaries": { -"methods": { +"path": "v1beta1/{+name}", +"response": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, +"scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", +"description": "Lists Assured Workloads under a CRM Node.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", "httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.dbFrameworkComplianceSummaries.list", +"id": "assuredworkloads.organizations.locations.workloads.list", "parameterOrder": [ "parent" ], "parameters": { "filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"description": "Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. Page size.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", -"enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" -], -"enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." -], -"location": "query", -"type": "string" } }, -"path": "v1beta1/{+parent}/dbFrameworkComplianceSummaries", +"path": "v1beta1/{+parent}/workloads", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] -} -} }, -"operations": { -"methods": { -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.get", +"patch": { +"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", +"httpMethod": "PATCH", +"id": "assuredworkloads.organizations.locations.workloads.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/operations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. The list of fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/operations", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.operations.list", +"restrictAllowedResources": { +"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", "parameterOrder": [ "name" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" -}, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", -"location": "query", -"type": "string" -}, -"returnPartialSuccess": { -"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", -"location": "query", -"type": "boolean" } }, -"path": "v1beta1/{+name}/operations", +"path": "v1beta1/{+name}:restrictAllowedResources", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] } -} }, -"workloads": { +"resources": { +"updates": { "methods": { -"analyzeWorkloadMove": { -"description": "Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:analyzeWorkloadMove", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.analyzeWorkloadMove", +"apply": { +"description": "This endpoint creates a new operation to apply the given update.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", +"httpMethod": "POST", +"id": "assuredworkloads.organizations.locations.workloads.updates.apply", "parameterOrder": [ -"target" +"name" ], "parameters": { -"assetTypes": { -"description": "Optional. List of asset types to be analyzed, including and under the source resource. If empty, all assets are analyzed. The complete list of asset types is available [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", -"location": "query", -"repeated": true, +"name": { +"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", +"required": true, "type": "string" +} +}, +"path": "v1beta1/{+name}:apply", +"request": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/cloud-platform" +] }, +"list": { +"description": "This endpoint lists all updates for the given workload.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.updates.list", +"parameterOrder": [ +"parent" +], +"parameters": { "pageSize": { -"description": "Optional. Page size. If a value is not specified, the default value of 10 is used. The maximum value is 50.", +"description": "Page size. The default value is 20 and the max allowed value is 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. The page token from the previous response. It needs to be passed in the second and following requests.", -"location": "query", -"type": "string" -}, -"project": { -"description": "The source type is a project. Specify the project's relative resource name, formatted as either a project number or a project ID: \"projects/{PROJECT_NUMBER}\" or \"projects/{PROJECT_ID}\" For example: \"projects/951040570662\" when specifying a project number, or \"projects/my-project-123\" when specifying a project ID.", +"description": "Page token returned from previous request.", "location": "query", "type": "string" }, -"target": { -"description": "Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: \"organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}\" For example: \"organizations/123/locations/us-east1/workloads/assured-workload-2\"", +"parent": { +"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+target}:analyzeWorkloadMove", +"path": "v1beta1/{+parent}/updates", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"create": { -"description": "Creates Assured Workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", +"violations": { +"methods": { +"acknowledge": { +"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", "httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.create", +"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"externalId": { -"description": "Optional. A identifier associated with the workload and underlying projects which allows for the break down of billing costs for a workload. The value provided for the identifier will add a label to the workload and contained projects with the identifier as the value.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the new Workload's parent. Must be of the form `organizations/{org_id}/locations/{location_id}`.", +"name": { +"description": "Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" } }, -"path": "v1beta1/{+parent}/workloads", +"path": "v1beta1/{+name}:acknowledge", "request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" +"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest" }, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", "https://www.googleapis.com/auth/cloud-platform" ] }, -"delete": { -"description": "Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "DELETE", -"id": "assuredworkloads.organizations.locations.workloads.delete", +"get": { +"description": "Retrieves an Assured Workloads violation by its resource name.", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.get", "parameterOrder": [ "name" ], "parameters": { -"etag": { -"description": "Optional. The etag of the workload. If this is provided, it must match the server's etag.", -"location": "query", -"type": "string" -}, "name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", +"description": "Required. The resource name of the violation to retrieve (that is, the value of `Violation.name`). Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", "location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", +"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}", "response": { -"$ref": "GoogleProtobufEmpty" +"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] }, -"enableComplianceUpdates": { -"description": "This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have `resourcemanager.folders.getIamPolicy` and `resourcemanager.folders.setIamPolicy` permissions on the assured workload folder.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableComplianceUpdates", -"httpMethod": "PUT", -"id": "assuredworkloads.organizations.locations.workloads.enableComplianceUpdates", +"list": { +"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", +"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", +"httpMethod": "GET", +"id": "assuredworkloads.organizations.locations.workloads.violations.list", "parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:enableComplianceUpdates", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableComplianceUpdatesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"enableResourceMonitoring": { -"description": "Enable resource violation monitoring for a workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:enableResourceMonitoring", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.enableResourceMonitoring", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The `name` field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:enableResourceMonitoring", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1EnableResourceMonitoringResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets Assured Workload associated with a CRM Node", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists Assured Workloads under a CRM Node.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A custom filter for filtering by properties of a workload. At this time, only filtering by labels is supported.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token returned from previous request. Page token contains context from previous request. Page token needs to be passed in the second and following requests.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Parent Resource to list workloads from. Must be of the form `organizations/{org_id}/locations/{location}`.", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/workloads", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"patch": { -"description": "Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}", -"httpMethod": "PATCH", -"id": "assuredworkloads.organizations.locations.workloads.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The list of fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1beta1/{+name}", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Workload" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"restrictAllowedResources": { -"description": "Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}:restrictAllowedResources", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.restrictAllowedResources", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as \"organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}\". For example, \"organizations/123/locations/us-east1/workloads/assured-workload-1\".", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:restrictAllowedResources", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"updates": { -"methods": { -"apply": { -"description": "This endpoint creates a new operation to apply the given update.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates/{updatesId}:apply", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.updates.apply", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the update. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}/updates/{update_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/updates/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:apply", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "This endpoint lists all updates for the given workload.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/updates", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.updates.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Page size. The default value is 20 and the max allowed value is 100.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Page token returned from previous request.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. organizations/{org_id}/locations/{location_id}/workloads/{workload_id}", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/updates", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListWorkloadUpdatesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"violations": { -"methods": { -"acknowledge": { -"description": "Acknowledges an existing violation. By acknowledging a violation, users acknowledge the existence of a compliance violation in their workload and decide to ignore it due to a valid business justification. Acknowledgement is a permanent operation and it cannot be reverted.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}:acknowledge", -"httpMethod": "POST", -"id": "assuredworkloads.organizations.locations.workloads.violations.acknowledge", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the violation to acknowledge. Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:acknowledge", -"request": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest" -}, -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Retrieves an Assured Workloads violation by its resource name.", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations/{violationsId}", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the violation to retrieve (that is, the value of `Violation.name`). Format: `organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) that the violation belongs to. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", -"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}", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Violation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`", -"flatPath": "v1beta1/organizations/{organizationsId}/locations/{locationsId}/workloads/{workloadsId}/violations", -"httpMethod": "GET", -"id": "assuredworkloads.organizations.locations.workloads.violations.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `associatedOrgPolicyViolationId`, `cloudControlName`, `workloadDisplayName`, and `complianceType` (a framework ID). Example: `state = \"UNRESOLVED\" AND complianceType = \"builtin-fedramp-high\"`", -"location": "query", -"type": "string" -}, -"interval.endTime": { -"description": "The end of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"interval.startTime": { -"description": "The start of the time window.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListViolations` call. Provide this token to retrieve the subsequent page. When paginating, all other parameters that are provided to `ListViolations` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The workload to list violations for. To list violations across all workloads in an organization, use `-` as the workload ID. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, violations are listed for the entire organization and location, and the workload ID is ignored. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`", -"location": "path", -"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", -"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", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -} -} -} -} -}, -"projects": { -"resources": { -"locations": { -"resources": { -"dbFindingSummaries": { -"methods": { -"list": { -"description": "Lists summaries of the active findings in a Data Boundary scope (an organization, folder, or project), with one summary for each finding category.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFindingSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFindingSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the framework deployments whose findings are summarized. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent scope to list finding summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/dbFindingSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -}, -"dbFrameworkComplianceReports": { -"methods": { -"aggregate": { -"description": "Gets daily compliance reports over a time range for a framework that's deployed in a Data Boundary scope.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:aggregate", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.aggregate", -"parameterOrder": [ -"name" +"parent" ], "parameters": { "filter": { -"description": "Optional. A filter expression that restricts the framework deployments that are included in the report. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, and `framework_revision` (the major revision ID of the framework).", +"description": "Optional. A filter expression that restricts the violations that are returned. The syntax follows [AIP-160](https://google.aip.dev/160). Only the equality operator (`=`) is supported, and expressions can be combined with `AND`, `OR`, and `NOT`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `violationId`, `category`, `state` (`UNRESOLVED`, `RESOLVED`, or `EXCEPTION`), `violationType` (`ORG_POLICY` or `RESOURCE`), `resourceType`, `resourceName`, `project`, `associatedOrgPolicyViolationId`, `cloudControlName`, `workloadDisplayName`, and `complianceType` (a framework ID). Example: `state = \"UNRESOLVED\" AND complianceType = \"builtin-fedramp-high\"`", "location": "query", "type": "string" }, "interval.endTime": { -"description": "Optional. Exclusive end of the interval. If specified, a Timestamp matching this interval will have to be before the end.", +"description": "The end of the time window.", "format": "google-datetime", "location": "query", "type": "string" }, "interval.startTime": { -"description": "Optional. Inclusive start of the interval. If specified, a Timestamp matching this interval will have to be the same or after the start.", -"format": "google-datetime", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The name of the framework compliance report to aggregate over time. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Format: `organizations/{organization_id}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:aggregate", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"fetch": { -"description": "Fetches the current compliance report for a framework that's deployed in a Data Boundary scope (an organization, folder, or project). The report includes the number of passing, failing, and not assessed controls in the framework.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}:fetch", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.fetch", -"parameterOrder": [ -"name" -], -"parameters": { -"endTime": { -"description": "Optional. The end time of the report. Reserved for future use. Currently, the report always reflects the current compliance state.", +"description": "The start of the time window.", "format": "google-datetime", "location": "query", "type": "string" }, -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The name of the framework compliance report to retrieve. The report ID is the ID of the compliance framework, for example `builtin-fedramp-high`. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+name}:fetch", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, -"resources": { -"dbControlComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the controls in a framework compliance report.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceReports/{dbFrameworkComplianceReportsId}/dbControlComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceReports.dbControlComplianceSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. The syntax follows [AIP-160](https://google.aip.dev/160). Supported fields are `framework_deployment`, `framework_name`, `framework_revision` (the major revision ID of the framework), and `end_time`. The `end_time` field accepts a single equality comparison with an [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) timestamp, for example `end_time = \"2026-01-01T00:00:00Z\"`. Only findings that were updated at or after this time are counted.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The framework compliance report to list control compliance summaries for. Formats: * `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `folders/{folder}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}` * `projects/{project}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dbFrameworkComplianceReports/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+parent}/dbControlComplianceSummaries", -"response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -} -} -} -}, -"dbFrameworkComplianceSummaries": { -"methods": { -"list": { -"description": "Lists the compliance summaries of the frameworks that are deployed in a Data Boundary scope (an organization, folder, or project).", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/dbFrameworkComplianceSummaries", -"httpMethod": "GET", -"id": "assuredworkloads.projects.locations.dbFrameworkComplianceSummaries.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. A filter expression that restricts the results. Reserved for future use.", +"orderBy": { +"description": "Optional. A comma-separated list of fields to sort the results by. The default sort order is ascending; to sort in descending order, append ` desc` to the field name. For example, `update_time desc,category`. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, the following fields are supported: `begin_time`, `update_time`, `resource_type`, `state`, and `category`. If not specified, results are sorted by `begin_time` in descending order.", "location": "query", "type": "string" }, "pageSize": { -"description": "Optional. The requested page size. The server might return fewer items than requested. If unspecified, the default page size is 50. The maximum value is 1000.", +"description": "Optional. The maximum number of violations to return. The service might return fewer violations than this value. If unspecified, at most 100 violations are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A token that identifies the page of results that the server should return. Pass the `next_page_token` value from a previous result.", +"description": "Optional. A page token, received from a previous `ListViolations` call. Provide this token to retrieve the subsequent page. When paginating, all other parameters that are provided to `ListViolations` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent scope to list framework compliance summaries for. Formats: * `organizations/{organization}/locations/{location}` * `folders/{folder}/locations/{location}` * `projects/{project}/locations/{location}`", +"description": "Required. The workload to list violations for. To list violations across all workloads in an organization, use `-` as the workload ID. When `view` is `VIOLATION_VIEW_DATA_BOUNDARY`, violations are listed for the entire organization and location, and the workload ID is ignored. Format: `organizations/{organization}/locations/{location}/workloads/{workload}`", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" }, "view": { -"description": "Optional. The level of detail to return for each summary. If not specified, `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC` is used.", +"description": "Optional. The violation view (`VIOLATION_VIEW_ASSURED_WORKLOADS` or `VIOLATION_VIEW_DATA_BOUNDARY`) to list violations for. If not specified, `VIOLATION_VIEW_ASSURED_WORKLOADS` is used.", "enum": [ -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_UNSPECIFIED", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_BASIC", -"FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL" +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" ], "enumDescriptions": [ -"The default / unset value. The API will default to the BASIC view.", -"Includes basic compliance metadata, but omits trend data.", -"Includes all information, including finding_count and controls_passing_trend. Trend data is provided for the last 30 days." +"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}/dbFrameworkComplianceSummaries", +"path": "v1beta1/{+parent}/violations", "response": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse" +"$ref": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/assuredworkloads", +"https://www.googleapis.com/auth/assuredworkloads.readonly", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1413,8 +740,10 @@ } } } +} +} }, -"revision": "20261026", +"revision": "20261106", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -1467,36 +796,6 @@ "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse": { -"description": "The response message for AggregateDbFrameworkComplianceReport.", -"id": "GoogleCloudAssuredworkloadsV1beta1AggregateDbFrameworkComplianceReportResponse", -"properties": { -"aggregatedComplianceReports": { -"description": "The daily compliance reports for the requested time range.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport": { -"description": "A point-in-time compliance report for a framework.", -"id": "GoogleCloudAssuredworkloadsV1beta1AggregatedComplianceReport", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework at `report_time`." -}, -"reportTime": { -"description": "The time that the compliance report represents.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse": { "description": "Response containing the analysis results for the hypothetical resource move.", "id": "GoogleCloudAssuredworkloadsV1beta1AnalyzeWorkloadMoveResponse", @@ -1565,266 +864,33 @@ }, "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse": { "description": "Response for ApplyWorkloadUpdate endpoint.", -"id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse", -"properties": { -"appliedUpdate": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate", -"description": "The update that was applied." -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": { -"description": "Represents move analysis results for an asset.", -"id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis", -"properties": { -"analysisGroups": { -"description": "List of eligible analyses performed for the asset.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup" -}, -"type": "array" -}, -"asset": { -"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", -"type": "string" -}, -"assetType": { -"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1CELExpression": { -"description": "A Common Expression Language (CEL) expression that's used to create a rule.", -"id": "GoogleCloudAssuredworkloadsV1beta1CELExpression", -"properties": { -"expression": { -"description": "Required. The logical expression in CEL. The maximum length of the condition is 1000 characters. For more information, see [CEL expression](https://cloud.google.com/security-command-center/docs/compliance-manager-write-cel-expressions).", -"type": "string" -}, -"resourceTypesValues": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1StringList", -"description": "The resource instance types on which this expression is defined. The format is `/`. For example: `compute.googleapis.com/Instance`" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails": { -"description": "The cloud control assessment details for non-manual cloud controls.", -"id": "GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails", -"properties": { -"evaluationState": { -"description": "Output only. The evaluation status of the cloud control.", -"enum": [ -"EVALUATION_STATE_UNSPECIFIED", -"EVALUATION_STATE_PASSED", -"EVALUATION_STATE_FAILED", -"EVALUATION_STATE_NOT_ASSESSED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The control is passing.", -"The control is failing.", -"The control is not assessed." -], -"readOnly": true, -"type": "string" -}, -"findingsCount": { -"description": "The number of findings for the cloud control.", -"format": "int32", -"type": "integer" -}, -"orgPolicyFindingCount": { -"description": "Output only. Number of organization policy findings for the cloud control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"resourceFindingCount": { -"description": "Output only. Number of resource findings for the cloud control.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1CloudControlReport": { -"description": "The cloud control report.", -"id": "GoogleCloudAssuredworkloadsV1beta1CloudControlReport", -"properties": { -"categories": { -"description": "The list of categories for the cloud control.", -"items": { -"type": "string" -}, -"type": "array" -}, -"cloudControl": { -"description": "The name of the cloud control.", -"type": "string" -}, -"cloudControlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1CloudControlAssessmentDetails", -"description": "The details of a cloud control assessment." -}, -"cloudControlDeployment": { -"description": "The name of the cloud control deployment.", -"type": "string" -}, -"cloudControlType": { -"description": "The type of the cloud control.", -"enum": [ -"TYPE_UNSPECIFIED", -"CUSTOM", -"BUILT_IN" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A cloud control that's created and managed by you.", -"A cloud control that's provided and managed by Google." -], -"type": "string" -}, -"description": { -"description": "The description of the cloud control.", -"type": "string" -}, -"displayName": { -"description": "The display name of the cloud control.", -"type": "string" -}, -"enforcementMode": { -"description": "The enforcement mode of the cloud control.", -"enum": [ -"ENFORCEMENT_MODE_UNSPECIFIED", -"PREVENTIVE", -"DETECTIVE", -"AUDIT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The cloud control is enforced to prevent non-compliance.", -"The cloud control is enforced to detect non-compliance.", -"The cloud control is enforced to audit for non-compliance." -], -"type": "string" -}, -"findingCategory": { -"description": "The category of the finding.", -"type": "string" -}, -"findingSeverity": { -"description": "The severity of the finding.", -"enum": [ -"SEVERITY_UNSPECIFIED", -"CRITICAL", -"HIGH", -"MEDIUM", -"LOW" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", -"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", -"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", -"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." -], -"type": "string" -}, -"frameworkMajorRevisionIds": { -"description": "The major revision IDs of the frameworks that the cloud control belongs to.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"majorRevisionId": { -"description": "The major revision ID of the cloud control.", -"format": "int64", -"type": "string" -}, -"manualCloudControlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails", -"description": "The details of a manual cloud control assessment." -}, -"minorRevisionId": { -"description": "The minor revision ID of the cloud control.", -"format": "int64", -"type": "string" -}, -"rules": { -"description": "The list of rules that correspond to the cloud control.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Rule" -}, -"type": "array" -}, -"similarControls": { -"description": "The list of similar controls.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1SimilarControls" -}, -"type": "array" +"id": "GoogleCloudAssuredworkloadsV1beta1ApplyWorkloadUpdateResponse", +"properties": { +"appliedUpdate": { +"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadUpdate", +"description": "The update that was applied." } }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails": { -"description": "The details for a control assessment.", -"id": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", +"GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis": { +"description": "Represents move analysis results for an asset.", +"id": "GoogleCloudAssuredworkloadsV1beta1AssetMoveAnalysis", "properties": { -"assessedPassingControlIds": { -"description": "The list of controls that were assessed and are passing.", -"items": { -"type": "string" -}, -"type": "array" -}, -"assessedPassingControls": { -"description": "The number of controls that were assessed and are passing.", -"format": "int32", -"type": "integer" -}, -"failingControlIds": { -"description": "The list of controls that are failing.", +"analysisGroups": { +"description": "List of eligible analyses performed for the asset.", "items": { -"type": "string" +"$ref": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup" }, "type": "array" }, -"failingControls": { -"description": "The number of controls that are failing.", -"format": "int32", -"type": "integer" -}, -"notAssessedControlIds": { -"description": "The list of controls that aren't assessed because they require manual review.", -"items": { +"asset": { +"description": "The full resource name of the asset being analyzed. Example: //compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1", "type": "string" }, -"type": "array" -}, -"notAssessedControls": { -"description": "The number of controls that aren't assessed because they require manual review.", -"format": "int32", -"type": "integer" -}, -"passingControlIds": { -"description": "The list of controls that are passing or not assessed.", -"items": { +"assetType": { +"description": "Type of the asset being analyzed. Possible values will be among the ones listed [here](https://cloud.google.com/asset-inventory/docs/supported-asset-types).", "type": "string" -}, -"type": "array" -}, -"passingControls": { -"description": "The number of controls that are passing or not assessed.", -"format": "int32", -"type": "integer" } }, "type": "object" @@ -1909,395 +975,95 @@ false, false, false, false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"The default value. This value is used if the control package is omitted or unknown.", -"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", -"Australia Data Boundary and Support", -"Canada Data Boundary and Support", -"Data Boundary for Canada Controlled Goods", -"Data Boundary for Canada Protected B", -"Data Boundary for Criminal Justice Information Systems (CJIS)", -"Data Boundary for FedRAMP High", -"Data Boundary for FedRAMP Moderate", -"Data Boundary for Impact Level 2 (IL2)", -"Data Boundary for Impact Level 4 (IL4)", -"Data Boundary for Impact Level 5 (IL5)", -"Data Boundary for IRS Publication 1075", -"Data Boundary for International Traffic in Arms Regulations (ITAR)", -"European Union (EU) Data Boundary and Support", -"Israel Data Boundary and Support", -"Japan Data Boundary", -"Switzerland Data Boundary with Access Justifications", -"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", -"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", -"United States (US) Data Boundary and Support", -"United States (US) Data Boundary for Healthcare and Life Sciences", -"United States (US) Data Boundary for Healthcare and Life Sciences with Support", -"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", -"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", -"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." -], -"type": "string" -}, -"createTime": { -"description": "Optional. Time when the operation was created.", -"format": "google-datetime", -"type": "string" -}, -"displayName": { -"description": "Optional. The display name of the workload.", -"type": "string" -}, -"parent": { -"description": "Optional. The parent of the workload.", -"type": "string" -}, -"resourceSettings": { -"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary": { -"description": "A summary of the compliance status of a control in a framework compliance report.", -"id": "GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary", -"properties": { -"cloudControlReports": { -"description": "The list of cloud control reports.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1CloudControlReport" -}, -"type": "array" -}, -"complianceFrameworks": { -"description": "The list of compliance frameworks that the control belongs to.", -"items": { -"type": "string" -}, -"type": "array" -}, -"control": { -"description": "The name of the control.", -"type": "string" -}, -"controlResponsibilityType": { -"description": "The responsibility type for the control.", -"enum": [ -"REGULATORY_CONTROL_RESPONSIBILITY_TYPE_UNSPECIFIED", -"GOOGLE", -"CUSTOMER", -"SHARED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Google's responsibility.", -"Your responsibility.", -"Shared responsibility." -], -"type": "string" -}, -"description": { -"description": "The description of the control.", -"type": "string" -}, -"displayName": { -"description": "The display name of the control.", -"type": "string" -}, -"isFakeControl": { -"description": "Whether the control is a fake control. Fake controls are created and mapped to cloud controls that don't belong to a control group.", -"type": "boolean" -}, -"name": { -"description": "Identifier. The resource name of the control compliance summary. Format: `organizations/{organization}/locations/{location}/dbFrameworkComplianceReports/{db_framework_compliance_report}/dbControlComplianceSummaries/{db_control_compliance_summary}`", -"type": "string" -}, -"orgPolicyFindingCount": { -"description": "Output only. Number of organization policy findings for this control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"overallEvaluationState": { -"description": "Output only. The overall evaluation status of the control.", -"enum": [ -"EVALUATION_STATE_UNSPECIFIED", -"EVALUATION_STATE_PASSED", -"EVALUATION_STATE_FAILED", -"EVALUATION_STATE_NOT_ASSESSED" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The control is passing.", -"The control is failing.", -"The control is not assessed." -], -"readOnly": true, -"type": "string" -}, -"resourceFindingCount": { -"description": "Output only. Number of resource findings for this control.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"similarControls": { -"description": "The list of similar controls.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1SimilarControls" -}, -"type": "array" -}, -"totalFindingsCount": { -"description": "The total number of findings for the control.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1DbFindingSummary": { -"description": "A summary of the active findings for a finding category in a Data Boundary scope.", -"id": "GoogleCloudAssuredworkloadsV1beta1DbFindingSummary", -"properties": { -"findingCategory": { -"description": "Output only. The category of the findings that are summarized.", -"readOnly": true, -"type": "string" -}, -"findingClass": { -"description": "Output only. The class of the findings.", -"enum": [ -"FINDING_CLASS_UNSPECIFIED", -"THREAT", -"VULNERABILITY", -"MISCONFIGURATION", -"OBSERVATION", -"SCC_ERROR", -"POSTURE_VIOLATION", -"TOXIC_COMBINATION", -"SENSITIVE_DATA_RISK", -"CHOKEPOINT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The activity is unwanted or malicious.", -"A potential weakness in software that increases risk to confidentiality, integrity, and availability.", -"A potential weakness in a cloud resource or asset configuration that increases risk.", -"A security observation that is for informational purposes.", -"An error that prevents Security Command Center from functioning properly.", -"A potential security risk that's due to a change in the security posture.", -"A combination of security issues that represent a more severe security problem when taken together.", -"A potential security risk to data assets that contain sensitive data.", -"A resource or resource group where high risk attack paths converge, based on attack path simulations (APS)." -], -"readOnly": true, -"type": "string" -}, -"findingCount": { -"description": "Output only. The total number of active findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Identifier. The resource name of the finding summary.", -"type": "string" -}, -"organizationPolicyFindingCount": { -"description": "Output only. The number of active organization policy findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"relatedFrameworks": { -"description": "Optional. The display names of the compliance frameworks that the findings are related to.", -"items": { -"type": "string" -}, -"type": "array" -}, -"resourceFindingCount": { -"description": "Output only. The number of active resource findings in the category.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"severity": { -"description": "Output only. The severity of the findings.", -"enum": [ -"SEVERITY_UNSPECIFIED", -"CRITICAL", -"HIGH", -"MEDIUM", -"LOW" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A critical vulnerability is easily discoverable by an external actor, exploitable, and results in the direct ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. Examples include publicly accessible unprotected user data and public SSH access with weak or no passwords. A critical threat is a threat that can access, modify, or delete data or execute unauthorized code within existing resources.", -"A high-risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities to gain direct access and the ability to execute arbitrary code, exfiltrate data, and otherwise gain additional access and privileges to cloud resources and workloads. An example is a database with weak or no passwords that is only accessible internally. This database could easily be compromised by an actor that had access to the internal network. A high-risk threat is a threat that can create new computational resources in an environment but can't access data or execute code in existing resources.", -"A medium-risk vulnerability can be used by an actor to gain access to resources or privileges that enable them to eventually (through multiple steps or a complex exploit) gain access and the ability to execute arbitrary code or exfiltrate data. An example is a service account with access to more projects than it should have. If an actor gains access to the service account, they could potentially use that access to manipulate a project the service account was not intended to. A medium-risk threat can cause operational impact but might not access data or execute unauthorized code.", -"A low-risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment, or prevents the root cause investigation of security issues. An example is monitoring and logs being disabled for resource configurations and access. A low-risk threat is a threat that has obtained minimal access to an environment but can't access data, execute code, or create resources." -], -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time when the findings in the category were last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary": { -"description": "A summary of the compliance status of a framework that's deployed in a Data Boundary scope.", -"id": "GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework." -}, -"controlsPassingTrend": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1Trend", -"description": "Output only. The trend of passing controls over the trend duration. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.", -"readOnly": true -}, -"findingCount": { -"description": "Output only. The number of findings that were generated against the framework. This field is only populated when using `FRAMEWORK_COMPLIANCE_SUMMARY_VIEW_FULL`.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"framework": { -"description": "The resource name of the compliance framework.", -"type": "string" -}, -"frameworkCategories": { -"description": "The categories of the framework.", -"items": { -"enum": [ -"FRAMEWORK_CATEGORY_UNSPECIFIED", -"INDUSTRY_DEFINED_STANDARD", -"ASSURED_WORKLOADS", -"DATA_SECURITY", -"GOOGLE_BEST_PRACTICES", -"CUSTOM_FRAMEWORK" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"An industry-defined framework.", -"An Assured Workloads framework.", -"A data security posture framework.", -"A Google's best practices framework.", -"A user-created framework." -], -"type": "string" -}, -"type": "array" -}, -"frameworkDisplayName": { -"description": "Optional. The display name of the framework.", -"type": "string" -}, -"frameworkType": { -"description": "The type of the framework.", -"enum": [ -"FRAMEWORK_TYPE_UNSPECIFIED", -"BUILT_IN", -"CUSTOM" +false, +false, +false, +false, +false, +false, +false, +false, +true, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false ], "enumDescriptions": [ -"Default value. This value is unused.", -"A framework that's provided and managed by Google.", -"A framework that's created and managed by you." +"The default value. This value is used if the control package is omitted or unknown.", +"Specifies a [Sovereign Controls by Partners](https://cloud.google.com/sovereign-controls-by-partners/docs/overview) control package. To use this control package, you must also specify the partner field from the list of Sovereign Controls by Partners.", +"Australia Data Boundary and Support", +"Canada Data Boundary and Support", +"Data Boundary for Canada Controlled Goods", +"Data Boundary for Canada Protected B", +"Data Boundary for Criminal Justice Information Systems (CJIS)", +"Data Boundary for FedRAMP High", +"Data Boundary for FedRAMP Moderate", +"Data Boundary for Impact Level 2 (IL2)", +"Data Boundary for Impact Level 4 (IL4)", +"Data Boundary for Impact Level 5 (IL5)", +"Data Boundary for IRS Publication 1075", +"Data Boundary for International Traffic in Arms Regulations (ITAR)", +"European Union (EU) Data Boundary and Support", +"Israel Data Boundary and Support", +"Japan Data Boundary", +"Switzerland Data Boundary with Access Justifications", +"Kingdom of Saudi Arabia (KSA) Data Boundary with Access Justifications", +"Data boundary for one of Assured Workloads' *Free tier* control packages. Determines the region by specifying the data location during workload creation.", +"United States (US) Data Boundary and Support", +"United States (US) Data Boundary for Healthcare and Life Sciences", +"United States (US) Data Boundary for Healthcare and Life Sciences with Support", +"Use the AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_PROTECTED_B enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the CANADA_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_CJIS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the EU_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_HIGH enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_FEDRAMP_MODERATE enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Deprecated: Consider using the Data Boundary for US Healthcare and Life Sciences control package instead.", +"Use the DATA_BOUNDARY_FOR_IL2 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL4 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IL5 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075 enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the ISRAEL_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the DATA_BOUNDARY_FOR_ITAR enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the JAPAN_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the REGIONAL_DATA_BOUNDARY enum for this control package instead, as the name of the associated Assured Workloads control package has changed.", +"Use the US_DATA_BOUNDARY_AND_SUPPORT enum for this control package instead, as the name of the associated Assured Workloads control package has changed." ], "type": "string" }, -"majorRevisionId": { -"description": "The major revision ID of the framework.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The minor revision ID of the framework.", -"format": "int64", +"createTime": { +"description": "Optional. Time when the operation was created.", +"format": "google-datetime", "type": "string" }, -"name": { -"description": "Identifier. The resource name of the framework compliance summary.", +"displayName": { +"description": "Optional. The display name of the workload.", "type": "string" }, -"supportedCloudProviders": { -"description": "The cloud providers that are supported by the framework.", -"items": { -"enum": [ -"CLOUD_PROVIDER_UNSPECIFIED", -"AWS", -"AZURE", -"GCP" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Amazon Web Services (AWS).", -"Microsoft Azure.", -"Google Cloud." -], +"parent": { +"description": "Optional. The parent of the workload.", "type": "string" }, -"type": "array" -}, -"targetResourceDetails": { -"description": "The details of the target resources (organizations, folders, or projects) that the framework is deployed on.", +"resourceSettings": { +"description": "Optional. Resource properties in the input that are used for creating/customizing workload resources.", "items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails" +"$ref": "GoogleCloudAssuredworkloadsV1beta1WorkloadResourceSettings" }, "type": "array" } @@ -2316,169 +1082,6 @@ false "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse": { -"description": "The response message for FetchDbFrameworkComplianceReport.", -"id": "GoogleCloudAssuredworkloadsV1beta1FetchDbFrameworkComplianceReportResponse", -"properties": { -"controlAssessmentDetails": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1ControlAssessmentDetails", -"description": "The number of passing, failing, and not assessed controls in the framework." -}, -"framework": { -"description": "The resource name of the compliance framework. For example, `organizations/{organization}/locations/{location}/frameworks/{framework_id}`.", -"type": "string" -}, -"frameworkCategories": { -"description": "The categories of the framework.", -"items": { -"enum": [ -"FRAMEWORK_CATEGORY_UNSPECIFIED", -"INDUSTRY_DEFINED_STANDARD", -"ASSURED_WORKLOADS", -"DATA_SECURITY", -"GOOGLE_BEST_PRACTICES", -"CUSTOM_FRAMEWORK" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"An industry-defined framework.", -"An Assured Workloads framework.", -"A data security posture framework.", -"A Google's best practices framework.", -"A user-created framework." -], -"type": "string" -}, -"type": "array" -}, -"frameworkDescription": { -"description": "The description of the framework.", -"type": "string" -}, -"frameworkDisplayName": { -"description": "Optional. The display name of the framework.", -"type": "string" -}, -"frameworkType": { -"description": "The type of the framework.", -"enum": [ -"FRAMEWORK_TYPE_UNSPECIFIED", -"BUILT_IN", -"CUSTOM" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"A framework that's provided and managed by Google.", -"A framework that's created and managed by you." -], -"type": "string" -}, -"majorRevisionId": { -"description": "The latest major revision ID of the framework.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The latest minor revision ID of the latest major revision of the framework.", -"format": "int64", -"type": "string" -}, -"name": { -"description": "The resource name of the framework compliance report.", -"type": "string" -}, -"supportedCloudProviders": { -"description": "The cloud providers that are supported by the framework.", -"items": { -"enum": [ -"CLOUD_PROVIDER_UNSPECIFIED", -"AWS", -"AZURE", -"GCP" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"Amazon Web Services (AWS).", -"Microsoft Azure.", -"Google Cloud." -], -"type": "string" -}, -"type": "array" -}, -"targetResourceDetails": { -"description": "The details of the target resources (organizations, folders, or projects) that the framework is deployed on.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails" -}, -"type": "array" -}, -"updateTime": { -"description": "Output only. The time when the report was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse": { -"description": "The response message for ListDbControlComplianceSummaries.", -"id": "GoogleCloudAssuredworkloadsV1beta1ListDbControlComplianceSummariesResponse", -"properties": { -"dbControlComplianceSummaries": { -"description": "The list of control compliance summaries.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1DbControlComplianceSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse": { -"description": "The response message for ListDbFindingSummaries.", -"id": "GoogleCloudAssuredworkloadsV1beta1ListDbFindingSummariesResponse", -"properties": { -"dbFindingSummaries": { -"description": "The list of finding summaries, one for each finding category.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1DbFindingSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse": { -"description": "The response message for ListDbFrameworkComplianceSummaries.", -"id": "GoogleCloudAssuredworkloadsV1beta1ListDbFrameworkComplianceSummariesResponse", -"properties": { -"dbFrameworkComplianceSummaries": { -"description": "The list of framework compliance summaries.", -"items": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1DbFrameworkComplianceSummary" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Output only. A token that can be sent as `page_token` to retrieve the next page. If this field is empty, there are no subsequent pages.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse": { "description": "Response message for the `ListViolations` method.", "id": "GoogleCloudAssuredworkloadsV1beta1ListViolationsResponse", @@ -2538,20 +1141,6 @@ false }, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails": { -"description": "The details for a manual cloud control assessment.", -"id": "GoogleCloudAssuredworkloadsV1beta1ManualCloudControlAssessmentDetails", -"properties": { -"manualCloudControlGuide": { -"description": "The guide for assessing a cloud control manually.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup": { "description": "Represents a logical group of checks performed for an asset. If successful, the group contains the analysis result, otherwise it contains an error with the failure reason.", "id": "GoogleCloudAssuredworkloadsV1beta1MoveAnalysisGroup", @@ -2718,127 +1307,6 @@ false "properties": {}, "type": "object" }, -"GoogleCloudAssuredworkloadsV1beta1Rule": { -"description": "A rule in the cloud control.", -"id": "GoogleCloudAssuredworkloadsV1beta1Rule", -"properties": { -"celExpression": { -"$ref": "GoogleCloudAssuredworkloadsV1beta1CELExpression", -"description": "The rule's logic expression in Common Expression Language (CEL)." -}, -"description": { -"description": "Optional. The rule description. The maximum length is 2000 characters.", -"type": "string" -}, -"ruleActionTypes": { -"description": "Required. The functionality that's enabled by the rule.", -"items": { -"enum": [ -"RULE_ACTION_TYPE_UNSPECIFIED", -"RULE_ACTION_TYPE_PREVENTIVE", -"RULE_ACTION_TYPE_DETECTIVE", -"RULE_ACTION_TYPE_AUDIT" -], -"enumDescriptions": [ -"Default value. This value is unused.", -"The rule is intended to prevent non-compliance.", -"The rule is intended to detect non-compliance.", -"The rule is intended to audit non-compliance." -], -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1SimilarControls": { -"description": "The similar controls.", -"id": "GoogleCloudAssuredworkloadsV1beta1SimilarControls", -"properties": { -"controlId": { -"description": "The ID of the control.", -"type": "string" -}, -"framework": { -"description": "The name of the framework.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1StringList": { -"description": "A list of strings for the parameter value.", -"id": "GoogleCloudAssuredworkloadsV1beta1StringList", -"properties": { -"values": { -"description": "Required. The strings in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails": { -"description": "The details for a target resource.", -"id": "GoogleCloudAssuredworkloadsV1beta1TargetResourceDetails", -"properties": { -"createTime": { -"description": "The create time of the target resource.", -"format": "google-datetime", -"type": "string" -}, -"frameworkDeployment": { -"description": "The framework deployment name for the target resource. For example, `organizations/{organization_id}/locations/{location}/frameworkDeployments/{framework_deployment_id}`", -"type": "string" -}, -"majorRevisionId": { -"description": "The major revision ID of the framework for the target resource.", -"format": "int64", -"type": "string" -}, -"minorRevisionId": { -"description": "The minor revision ID of the framework for the target resource.", -"format": "int64", -"type": "string" -}, -"targetResource": { -"description": "The target resource. For example, `organizations/1234567890`, `projects/1234567890`, or `folders/1234567890`.", -"type": "string" -}, -"targetResourceDisplayName": { -"description": "The display name of the target resource. For example, `google.com`, `staging-project`, or `development-folder`.", -"type": "string" -}, -"updateTime": { -"description": "The update time of the target resource.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAssuredworkloadsV1beta1Trend": { -"description": "The trend of a compliance metric.", -"id": "GoogleCloudAssuredworkloadsV1beta1Trend", -"properties": { -"duration": { -"description": "Output only. The duration for the trend.", -"format": "google-duration", -"readOnly": true, -"type": "string" -}, -"valuePercent": { -"description": "Output only. The trend value as a percentage. The value can be positive or negative.", -"format": "double", -"readOnly": true, -"type": "number" -} -}, -"type": "object" -}, "GoogleCloudAssuredworkloadsV1beta1UpdateDetails": { "description": "The details of the update.", "id": "GoogleCloudAssuredworkloadsV1beta1UpdateDetails", diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 0c7b11fcee..57ea0879aa 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -671,7 +671,7 @@ ], "parameters": { "etag": { -"description": "The current etag of the autoprotectionpolicy. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.", +"description": "Optional. The current etag of the autoprotectionpolicy. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.", "location": "query", "type": "string" }, @@ -3863,7 +3863,7 @@ } } }, -"revision": "20261028", +"revision": "20261105", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -4512,7 +4512,7 @@ "type": "string" }, "etag": { -"description": "Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.", +"description": "Output only. The etag for the binding. If this is provided on update, it must match the server's etag.", "type": "string" }, "name": { @@ -5634,11 +5634,13 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`", +"description": "Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`", +"readOnly": true, "type": "string" }, "resource": { -"description": "Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).", +"description": "Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).", +"readOnly": true, "type": "string" } }, @@ -7579,7 +7581,7 @@ "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -9262,7 +9264,7 @@ "type": "object" }, "RestoreVerificationPlan": { -"description": "A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion.", +"description": "A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion.", "id": "RestoreVerificationPlan", "properties": { "createTime": { @@ -9357,7 +9359,7 @@ "type": "object" }, "name": { -"description": "Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}", +"description": "Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1beta.json b/googleapiclient/discovery_cache/documents/backupdr.v1beta.json index 505a2bc5d1..2a0aed70bd 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1beta.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1beta.json @@ -671,7 +671,7 @@ ], "parameters": { "etag": { -"description": "The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.", +"description": "Optional. The current etag of the AutoProtectionPolicy. If an etag is provided and does not match the current etag of the connection, the request will be rejected with an ABORTED error.", "location": "query", "type": "string" }, @@ -3863,7 +3863,7 @@ } } }, -"revision": "20261028", +"revision": "20261105", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -4512,7 +4512,7 @@ "type": "string" }, "etag": { -"description": "Optional. Output only. The etag for the binding. If this is provided on update, it must match the server's etag.", +"description": "Output only. The etag for the binding. If this is provided on update, it must match the server's etag.", "type": "string" }, "name": { @@ -5643,11 +5643,13 @@ "type": "string" }, "name": { -"description": "Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`", +"description": "Output only. Identifier. The resource name of the `BindingMatchingResource`. Format: `projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}/bindings/{binding}/matchingResources/{matching_resource}`", +"readOnly": true, "type": "string" }, "resource": { -"description": "Required. Immutable. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).", +"description": "Output only. Resource name of the workload that matches the criteria of the binding. The format can be either a relative resource name (e.g., `projects/my-project/zones/us-central1-a/instances/my-instance`) or a schemeless full resource name (e.g., `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`).", +"readOnly": true, "type": "string" } }, @@ -7518,7 +7520,7 @@ "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -9221,7 +9223,7 @@ false "type": "object" }, "RestoreVerificationPlan": { -"description": "A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `RestoreVerificationSchedule` to dictate when the verifications should run, and a `CleanupConfig` for post-verification resource deletion.", +"description": "A `RestoreVerificationPlan` specifies the scheduling and clean-up template for automated restore verification. It contains a `schedule` to dictate when the verifications should run, and a `RestoreVerificationCleanupRule` for post-verification resource deletion.", "id": "RestoreVerificationPlan", "properties": { "createTime": { @@ -9316,7 +9318,7 @@ false "type": "object" }, "name": { -"description": "Output only. Identifier. The resource name of RestoreVerificationPlanAssociation in below format Format : projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}", +"description": "Output only. Identifier. The resource name of the `RestoreVerificationPlanAssociation`. Format: `projects/{project}/locations/{location}/restoreVerificationPlans/{restore_verification_plan}/associations/{association}`", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index f5e21f0d00..6b72a5923d 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -317,13 +317,17 @@ "DATASET_VIEW_UNSPECIFIED", "METADATA", "ACL", -"FULL" +"FULL", +"BASIC", +"BASIC_REPLICA_METADATA_VIEW" ], "enumDescriptions": [ "The default value. Default to the FULL view.", "View metadata information for the dataset, such as friendlyName, description, labels, etc.", "View ACL information for the dataset, which defines dataset access for one or more entities.", -"View both dataset metadata and ACL information." +"View both dataset metadata and ACL information.", +"View both dataset metadata and ACL information.", +"Includes everything from the BASIC view plus replication information. However, it will not include sync_status or other fields requiring cross-region requests." ], "location": "query", "type": "string" @@ -2395,7 +2399,7 @@ } } }, -"revision": "20261009", +"revision": "20261107", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2846,7 +2850,7 @@ "type": "object" }, "ArrowRecordBatch": { -"description": "Arrow RecordBatch. This feature is not yet available.", +"description": "Arrow RecordBatch. [Preview](https://cloud.google.com/products/#product-launch-stages)", "id": "ArrowRecordBatch", "properties": { "serializedRecordBatch": { @@ -2858,7 +2862,7 @@ "type": "object" }, "ArrowSchema": { -"description": "Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. This feature is not yet available.", +"description": "Arrow schema as specified in https://arrow.apache.org/docs/python/api/datatypes.html and serialized to bytes using IPC: https://arrow.apache.org/docs/format/Columnar.html#serialization-and-interprocess-communication-ipc See code samples on how this message can be deserialized. [Preview](https://cloud.google.com/products/#product-launch-stages)", "id": "ArrowSchema", "properties": { "serializedSchema": { @@ -2870,7 +2874,7 @@ "type": "object" }, "ArrowSerializationOptions": { -"description": "Contains options specific to Arrow Serialization. This feature is not yet available.", +"description": "Contains options specific to Arrow Serialization. [Preview](https://cloud.google.com/products/#product-launch-stages)", "id": "ArrowSerializationOptions", "properties": { "bufferCompression": { @@ -2882,7 +2886,7 @@ ], "enumDescriptions": [ "If unspecified no compression will be used.", -"LZ4 Frame (https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md)", +"[LZ4 Frame](https://github.com/lz4/lz4/blob/dev/doc/lz4_Frame_format.md)", "Zstandard compression." ], "type": "string" @@ -3088,6 +3092,20 @@ ], "type": "string" }, +"metadataExportMode": { +"description": "Optional. The type of Metadata Export for BigLake Managed Tables.", +"enum": [ +"METADATA_EXPORT_MODE_UNSPECIFIED", +"ASYNC", +"MANUAL" +], +"enumDescriptions": [ +"No export type specified. This will default to ASYNC.", +"Async export mode.", +"Manual metadata export." +], +"type": "string" +}, "storageUri": { "description": "Optional. The fully qualified location prefix of the external folder where table data is stored. The '*' wildcard character is not allowed. The URI should be in the format `gs://bucket/path_to_table/`", "type": "string" @@ -3843,6 +3861,10 @@ "$ref": "ExternalDatasetReference", "description": "Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL." }, +"failoverReservationId": { +"description": "Optional. The failover reservation associated with the dataset in the regionless format. Example: .. To learn about about failover reservations see: https://docs.cloud.google.com/bigquery/docs/managed-disaster-recovery#overview", +"type": "string" +}, "friendlyName": { "description": "Optional. A descriptive name for the dataset.", "type": "string" @@ -3893,6 +3915,13 @@ "format": "int64", "type": "string" }, +"replicas": { +"description": "Optional. The list of replicas in a cross region replicated or disaster recovery dataset.", +"items": { +"$ref": "Replica" +}, +"type": "array" +}, "resourceTags": { "additionalProperties": { "type": "string" @@ -5669,6 +5698,28 @@ }, "type": "object" }, +"InstalledPackage": { +"description": " Information about a package installed in the routine execution environment.", +"id": "InstalledPackage", +"properties": { +"name": { +"description": "Output only. The name of the installed package.", +"readOnly": true, +"type": "string" +}, +"sourceRepository": { +"description": "Output only. The source repository from which this package was installed. Populated only when the package was installed from an additional package repository. E.g. 'https://my-region-python.pkg.dev/my-project/my-repo/simple'", +"readOnly": true, +"type": "string" +}, +"version": { +"description": "Output only. The version of the installed package.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "IntArray": { "description": "An array of int.", "id": "IntArray", @@ -6976,6 +7027,11 @@ "description": "Output only. The schema of the results. Present only for successful dry run of non-legacy SQL queries.", "readOnly": true }, +"searchIndexingStats": { +"$ref": "SearchIndexingStats", +"description": "Output only. Search indexing specific statistics.", +"readOnly": true +}, "searchStatistics": { "$ref": "SearchStatistics", "description": "Output only. Search query specific statistics.", @@ -7048,6 +7104,11 @@ "readOnly": true, "type": "array" }, +"vectorSearchIndexingStats": { +"$ref": "VectorSearchIndexingStats", +"description": "Output only. Vector Search indexing specific statistics.", +"readOnly": true +}, "vectorSearchStatistics": { "$ref": "VectorSearchStatistics", "description": "Output only. Vector Search query specific statistics.", @@ -8225,10 +8286,21 @@ "description": "Options for a user-defined Python function.", "id": "PythonOptions", "properties": { +"buildConnection": { +"description": "Optional. Fully qualified name of the connection whose service account will be used to authenticate to private package repositories during build-time. Format: \"projects/{project_id}/locations/{location_id}/connections/{connection_id}\"", +"type": "string" +}, "entryPoint": { "description": "Required. The name of the function defined in Python code as the entry point when the Python UDF is invoked.", "type": "string" }, +"extraPackageRepositories": { +"description": "Optional. The list of additional package repositories to search when resolving Python packages. These repositories are searched in addition to the default public PyPI. Only repositories hosted in Artifact Registry (.pkg.dev) are supported. Only pre-compiled Wheel (.whl) packages are supported from these repositories. E.g. ['https://my-region-python.pkg.dev/my-project/my-repo/simple']", +"items": { +"type": "string" +}, +"type": "array" +}, "packages": { "description": "Optional. A list of Python package names along with versions to be installed. Example: [\"pandas>=2.1\", \"google-cloud-translate==3.11\"]. For more information, see [Use third-party packages](https://cloud.google.com/bigquery/docs/user-defined-functions-python#third-party-packages).", "items": { @@ -8460,7 +8532,7 @@ "type": "array" }, "queryResultsFormat": { -"description": "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.", +"description": "Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results is provided in the `QueryResponse.results_schema` field. * The results of the first page are provided in the `QueryResponse.results` field. * The `QueryResponse.rows` is not populated. * The `QueryResponse.schema` for `QueryResponse.rows` is not populated since it is the schema of the `QueryResponse.rows`. [Preview](https://cloud.google.com/products/#product-launch-stages)", "enum": [ "QUERY_RESULTS_FORMAT_UNSPECIFIED", "STRUCT_ENCODING", @@ -8469,7 +8541,7 @@ "enumDescriptions": [ "If unspecified it will default to struct `QueryResponse.rows` (`STRUCT_ENCODING`)", "Default encoding of results as struct in `QueryResponse.rows`", -"Arrow is a standard open source column-based message format. See https://arrow.apache.org/ for more details." +"Arrow is a standard open source column-based message format. See the Apache Arrow documentation for more details." ], "type": "string" }, @@ -8578,7 +8650,7 @@ "type": "string" }, "pageRowCount": { -"description": "Output only. The number of rows out of `total_rows` returned in this response. This feature is not yet available.", +"description": "Output only. The number of rows out of `total_rows` returned in this response. [Preview](https://cloud.google.com/products/#product-launch-stages)", "format": "int64", "readOnly": true, "type": "string" @@ -8869,6 +8941,103 @@ }, "type": "object" }, +"Replica": { +"description": "The replica metadata of the dataset. If the dataset has two or more replicas, it's considered a cross region replicated (CRR) dataset.", +"id": "Replica", +"properties": { +"backfillCompletionTime": { +"description": "Output only. The time when the backfill was completed and replica is ready to use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creationTime": { +"description": "Output only. The timestamp when the replica was created. For any dataset's first replica, this should be set to the dataset's creation_time.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"failoverReservationUri": { +"description": "Output only. Failover reservation ID for the replica's region if this replica is used for DR. Fully-qualified format, e.g. \"projects/some-project/locations/US/reservations/some-reservation\" The location portion of the format is upper case if \"US\" or \"EU\", otherwise a lower case cloud region like \"asia-northeast1\".", +"readOnly": true, +"type": "string" +}, +"id": { +"description": "Required. The user-visible string identifier for this dataset replica. This is generally named after the region.", +"type": "string" +}, +"location": { +"description": "Required. The logical bigquery region where this replica is located. This is upper case if \"US\" or \"EU\", otherwise a lower case cloud region like \"asia-northeast1\".", +"type": "string" +}, +"primaryAssignmentCompletionTime": { +"description": "Output only. After a new primary assignment is made, this is the time that the dataset's data has been fully replicated to the replica, and after which the system will use current reads in the new primary replica.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"primaryAssignmentTime": { +"description": "Output only. The time at which the replica was assigned primary. Only one replica will have this field populated at any point.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"replicaOptions": { +"$ref": "ReplicaOptions", +"description": "Optional. Contains modify options on the replica such as set a kms key on the replica." +}, +"replicaState": { +"description": "Output only. Gives an explicit indicator of the replica primary state.", +"enum": [ +"REPLICA_STATE_UNSPECIFIED", +"PRIMARY", +"SECONDARY", +"ASSIGNED_PRIMARY", +"PREVIOUSLY_ASSIGNED_PRIMARY", +"BACKFILLING" +], +"enumDescriptions": [ +"Should never be set.", +"Denotes that the replica is the primary. All routing by default goes to the primary and only the primary is writable.", +"Denotes that the replica is the secondary and is only readable.", +"This value for the replica where the new primary is going to be. At most one replica can have this value, and its only present when the dataset has a primary switch in progress.", +"This value for the replica where the last primary was, but is no longer assigned the primary. All routing still goes to this replica, but it is no longer writable. Only set on the old primary during a primary switch. At most one replica at any moment can have this value.", +"The replica is not queriable yet since it's still backfilling." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ReplicaOptions": { +"description": "Options set by the user when creating the replica. These include region-specific dataset values, for example default KMS key name. When a resource is replicated, the destination region's replica contains values that should be overwritten in the destination region.", +"id": "ReplicaOptions", +"properties": { +"defaultKmsKeyName": { +"description": "Optional. Default KMS encryption key name.", +"type": "string" +} +}, +"type": "object" +}, +"ResourcePolicyMember": { +"description": "Output-only policy member strings of a Google Cloud resource's built-in identity.", +"id": "ResourcePolicyMember", +"properties": { +"iamPolicyNamePrincipal": { +"description": "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`", +"readOnly": true, +"type": "string" +}, +"iamPolicyUidPrincipal": { +"description": "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`", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "RestrictionConfig": { "id": "RestrictionConfig", "properties": { @@ -9092,6 +9261,14 @@ "format": "int64", "readOnly": true, "type": "string" +}, +"installedPackages": { +"description": "Output only. The list of installed packages in the routine's execution environment. Populated only after the build succeeds.", +"items": { +"$ref": "InstalledPackage" +}, +"readOnly": true, +"type": "array" } }, "type": "object" @@ -9306,6 +9483,23 @@ }, "type": "object" }, +"SearchIndexingStats": { +"description": "Statistics for a search indexing job. Populated as part of JobStatistics2.", +"id": "SearchIndexingStats", +"properties": { +"baseTable": { +"$ref": "TableReference", +"description": "Output only. The base table for which the search index is being created or refreshed.", +"readOnly": true +}, +"indexName": { +"description": "Output only. The name of the search index.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "SearchStatistics": { "description": "Statistics for a search query. Populated as part of JobStatistics2.", "id": "SearchStatistics", @@ -10102,6 +10296,11 @@ "$ref": "PartitioningDefinition", "description": "Optional. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, iceberg partitioned, and metastore partitioned tables. This field is only populated for metastore partitioned tables. For other table formats, this is an output only field." }, +"policyMember": { +"$ref": "ResourcePolicyMember", +"description": "Output only. Contains the resource identity token of the view that users can use to include in their policy bindings for authorization. This should be set only for views.", +"readOnly": true +}, "rangePartitioning": { "$ref": "RangePartitioning", "description": "If specified, configures range partitioning for this table." @@ -11944,6 +12143,23 @@ }, "type": "object" }, +"VectorSearchIndexingStats": { +"description": "Statistics for a vector search indexing job. Populated as part of JobStatistics2.", +"id": "VectorSearchIndexingStats", +"properties": { +"baseTable": { +"$ref": "TableReference", +"description": "Output only. The base table for which the vector index is being created or refreshed.", +"readOnly": true +}, +"indexName": { +"description": "Output only. The name of the vector index.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "VectorSearchStatistics": { "description": "Statistics for a vector search query. Populated as part of JobStatistics2.", "id": "VectorSearchStatistics", diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json index 0353f1f5bb..3e108b973d 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json @@ -366,7 +366,7 @@ } } }, -"revision": "20260922", +"revision": "20261107", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { @@ -428,6 +428,11 @@ "identity": { "description": "A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role.", "type": "string" +}, +"serviceAccountId": { +"description": "Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AwsProperties.service_directory_service`.", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -443,6 +448,10 @@ "crossCloudCacheOptions": { "$ref": "CrossCloudCacheOptions", "description": "Optional. Configuration options for cross-cloud caching of data and metadata files." +}, +"serviceDirectoryService": { +"description": "Optional. The Service Directory resource name for routing traffic to AWS over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`. If both this field and `s3_service_directory_service` are set, this field takes precedence.", +"type": "string" } }, "type": "object" @@ -486,6 +495,15 @@ "redirectUri": { "description": "The URL user will be redirected to after granting consent during connection setup.", "type": "string" +}, +"serviceAccountId": { +"description": "Output only. The email address of the Google-owned service account that represents the connection's identity. Grant IAM roles to this service account, for example, to let the connection resolve the Service Directory service in `AzureProperties.service_directory_service`.", +"readOnly": true, +"type": "string" +}, +"serviceDirectoryService": { +"description": "Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format `projects/{project_id}/locations/{location}/namespaces/{namespace_id}/services/{service_id}`.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json index 540f3f5111..3a725efb0e 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json @@ -405,7 +405,7 @@ } } }, -"revision": "20260114", +"revision": "20261107", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json index 075fd35f47..2a274f3eb5 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v2.json @@ -18,6 +18,13 @@ "description": "Allows users to manage BigQuery data policies.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery/docs/column-data-masking", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://bigquerydatapolicy.us-central1.rep.googleapis.com/", +"location": "us-central1" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -429,7 +436,7 @@ } } }, -"revision": "20261021", +"revision": "20261106", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AddGranteesRequest": { diff --git a/googleapiclient/discovery_cache/documents/ces.v1.json b/googleapiclient/discovery_cache/documents/ces.v1.json index 51f398af5f..2415f08b35 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1.json +++ b/googleapiclient/discovery_cache/documents/ces.v1.json @@ -2677,7 +2677,7 @@ } } }, -"revision": "20261016", +"revision": "20261106", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -3473,7 +3473,7 @@ "type": "object" }, "ArtifactChunk": { -"description": "A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted.", +"description": "A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the Cloud Storage URI once the file has been persisted.", "id": "ArtifactChunk", "properties": { "artifactId": { @@ -3489,7 +3489,7 @@ "type": "string" }, "gcsUri": { -"description": "The GCS object the artifact was persisted to. Set on FINALIZED chunks.", +"description": "The Cloud Storage object the artifact was persisted to. Set on FINALIZED chunks.", "type": "string" }, "mimeType": { @@ -3515,6 +3515,11 @@ "The document finished streaming: its content was fully delivered via content_delta chunks. Persistence may still follow; a FINALIZED chunk with a gcs_uri is sent if and when the artifact is saved." ], "type": "string" +}, +"targetApp": { +"description": "Output only. The app this artifact was produced for, when it was produced for one. Format: `projects/{project}/locations/{location}/apps/{app}`", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -3555,6 +3560,13 @@ }, "type": "array" }, +"targets": { +"description": "Everything the confirmed action will change, so the console can render \"Update 2 apps\" and one badge per app. Empty for legacy single-target cards.", +"items": { +"$ref": "AssistantConfirmationRequestTarget" +}, +"type": "array" +}, "tool": { "description": "Name of the tool call the agent paused on (e.g. \"update_app\"), for the card header. Unset for pure questions.", "type": "string" @@ -3562,6 +3574,29 @@ }, "type": "object" }, +"AssistantConfirmationRequestTarget": { +"description": "One resource the confirmed action will change.", +"id": "AssistantConfirmationRequestTarget", +"properties": { +"action": { +"description": "The action, e.g. `CREATE`, `UPDATE`, `DELETE`, `COPY`, `LINK`.", +"type": "string" +}, +"displayName": { +"description": "Display name of the resource or app, for the card.", +"type": "string" +}, +"resource": { +"description": "The resource that will change, as a full resource name.", +"type": "string" +}, +"targetApp": { +"description": "The app the resource belongs to, or empty for a location-scoped action such as creating an app. Format: `projects/{project}/locations/{location}/apps/{app}`", +"type": "string" +} +}, +"type": "object" +}, "AssistantConfirmationResponse": { "description": "The user's answer to an AssistantConfirmationRequest, sent on the next SessionService.StreamChatAiAssistant call to resume the paused agent.", "id": "AssistantConfirmationResponse", @@ -5642,7 +5677,7 @@ "type": "string" }, "trafficAllocations": { -"description": "Optional. Traffic allocations for the version release.", +"description": "Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic.", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" }, @@ -5664,7 +5699,7 @@ "type": "string" }, "trafficPercentage": { -"description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100.", +"description": "Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`.", "format": "int32", "type": "integer" } @@ -5694,7 +5729,7 @@ "type": "string" }, "gcsUri": { -"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object.", +"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified Cloud Storage object.", "type": "string" } }, @@ -9041,12 +9076,14 @@ "enum": [ "CLIENT_CAPABILITY_UNSPECIFIED", "CONFIRMATION_CARDS", -"CLIENT_MANAGED_LRO" +"CLIENT_MANAGED_LRO", +"PROJECT_SCOPE" ], "enumDescriptions": [ "Unspecified capability; ignored.", "The client renders AssistantConfirmationRequest cards and answers them via `confirmation_response`.", -"The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline." +"The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline.", +"The client renders project-scope events: `typed_payload` cards, `target_app` on tool calls and responses, `targets` on confirmation requests and `touched_apps` on turn completion." ], "type": "string" }, @@ -9082,7 +9119,7 @@ "properties": { "artifactChunk": { "$ref": "ArtifactChunk", -"description": "Generated-document artifact event (live preview deltas + final GCS pointer)." +"description": "Generated-document artifact event (live preview deltas + final Cloud Storage pointer)." }, "confirmationRequest": { "$ref": "AssistantConfirmationRequest", @@ -9382,6 +9419,11 @@ "readOnly": true, "type": "string" }, +"targetApp": { +"description": "Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions.", +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" @@ -9453,6 +9495,11 @@ "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object" }, +"targetApp": { +"description": "Output only. The app the executed tool targeted; mirrors ToolCall.target_app.", +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" @@ -9717,6 +9764,13 @@ ], "type": "string" }, +"touchedApps": { +"description": "Apps this turn targeted or changed, so the console can refresh exactly those apps' stores. Project-scoped sessions only. Format: `projects/{project}/locations/{location}/apps/{app}`", +"items": { +"type": "string" +}, +"type": "array" +}, "turnId": { "description": "Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/ces.v1beta.json b/googleapiclient/discovery_cache/documents/ces.v1beta.json index a1d051dbe2..20ea10eb12 100644 --- a/googleapiclient/discovery_cache/documents/ces.v1beta.json +++ b/googleapiclient/discovery_cache/documents/ces.v1beta.json @@ -4146,7 +4146,7 @@ } } }, -"revision": "20261016", +"revision": "20261106", "rootUrl": "https://ces.googleapis.com/", "schemas": { "Action": { @@ -5221,7 +5221,7 @@ "type": "object" }, "ArtifactChunk": { -"description": "A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the GCS URI once the file has been persisted.", +"description": "A streamed fragment of a document artifact (e.g. a markdown TDD) that the assistant is generating. Content deltas stream while the document is being written so clients can render a live preview; the FINALIZED chunk carries the Cloud Storage URI once the file has been persisted.", "id": "ArtifactChunk", "properties": { "artifactId": { @@ -5237,7 +5237,7 @@ "type": "string" }, "gcsUri": { -"description": "The GCS object the artifact was persisted to. Set on FINALIZED chunks.", +"description": "The Cloud Storage object the artifact was persisted to. Set on FINALIZED chunks.", "type": "string" }, "mimeType": { @@ -5263,6 +5263,11 @@ "The document finished streaming: its content was fully delivered via content_delta chunks. Persistence may still follow; a FINALIZED chunk with a gcs_uri is sent if and when the artifact is saved." ], "type": "string" +}, +"targetApp": { +"description": "Output only. The app this artifact was produced for, when it was produced for one. Format: `projects/{project}/locations/{location}/apps/{app}`", +"readOnly": true, +"type": "string" } }, "type": "object" @@ -5335,6 +5340,13 @@ }, "type": "array" }, +"targets": { +"description": "Everything the confirmed action will change, so the console can render \"Update 2 apps\" and one badge per app. Empty for legacy single-target cards.", +"items": { +"$ref": "AssistantConfirmationRequestTarget" +}, +"type": "array" +}, "tool": { "description": "Name of the tool call the agent paused on (e.g. \"update_app\"), for the card header. Unset for pure questions.", "type": "string" @@ -5342,6 +5354,29 @@ }, "type": "object" }, +"AssistantConfirmationRequestTarget": { +"description": "One resource the confirmed action will change.", +"id": "AssistantConfirmationRequestTarget", +"properties": { +"action": { +"description": "The action, e.g. `CREATE`, `UPDATE`, `DELETE`, `COPY`, `LINK`.", +"type": "string" +}, +"displayName": { +"description": "Display name of the resource or app, for the card.", +"type": "string" +}, +"resource": { +"description": "The resource that will change, as a full resource name.", +"type": "string" +}, +"targetApp": { +"description": "The app the resource belongs to, or empty for a location-scoped action such as creating an app. Format: `projects/{project}/locations/{location}/apps/{app}`", +"type": "string" +} +}, +"type": "object" +}, "AssistantConfirmationResponse": { "description": "The user's answer to an AssistantConfirmationRequest, sent on the next SessionService.StreamChatAiAssistant call to resume the paused agent.", "id": "AssistantConfirmationResponse", @@ -5472,6 +5507,14 @@ "readOnly": true, "type": "string" }, +"touchedApps": { +"description": "Output only. Apps this session has targeted or changed (project-scoped sessions only), for history tags. Format: `projects/{project}/locations/{location}/apps/{app}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "updateTime": { "description": "Output only. The time the assistant session was last updated.", "format": "google-datetime", @@ -8657,6 +8700,14 @@ "readOnly": true, "type": "array" }, +"milestoneResults": { +"description": "Output only. The results of each milestone in the scenario.", +"items": { +"$ref": "EvaluationResultScenarioResultMilestoneResult" +}, +"readOnly": true, +"type": "array" +}, "rubricOutcomes": { "description": "Output only. The outcome of the rubric.", "items": { @@ -8713,6 +8764,40 @@ }, "type": "object" }, +"EvaluationResultScenarioResultMilestoneResult": { +"description": "Represents the result of a milestone execution.", +"id": "EvaluationResultScenarioResultMilestoneResult", +"properties": { +"justification": { +"description": "Output only. The justification for the current status.", +"readOnly": true, +"type": "string" +}, +"milestone": { +"$ref": "EvaluationScenarioMilestone", +"description": "Output only. The milestone being tracked.", +"readOnly": true +}, +"status": { +"description": "Output only. The current status of the milestone.", +"enum": [ +"MILESTONE_STATUS_UNSPECIFIED", +"NOT_STARTED", +"IN_PROGRESS", +"COMPLETED" +], +"enumDescriptions": [ +"Unspecified status.", +"The milestone has not started yet.", +"The milestone is currently in progress.", +"The milestone has been successfully completed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "EvaluationResultScenarioRubricOutcome": { "description": "The outcome of the evaluation against the rubric.", "id": "EvaluationResultScenarioRubricOutcome", @@ -9214,6 +9299,13 @@ "format": "int32", "type": "integer" }, +"milestones": { +"description": "Optional. The milestones for this scenario.", +"items": { +"$ref": "EvaluationScenarioMilestone" +}, +"type": "array" +}, "rubrics": { "description": "Required. The rubrics to score the scenario against.", "items": { @@ -9325,6 +9417,38 @@ }, "type": "object" }, +"EvaluationScenarioMilestone": { +"description": "Represents a single milestone in the scenario. Used to guide the behaviour of the user simulator to follow a protocol. The user simulator executes the milestone sequentially and only proceeds to the next one if the success_criteria of that milestone is achieved.", +"id": "EvaluationScenarioMilestone", +"properties": { +"event": { +"$ref": "Event", +"description": "Optional. An event input to send instead of dynamic generation." +}, +"goal": { +"description": "Required. The goal of the milestone.", +"type": "string" +}, +"maxTurnCount": { +"description": "Optional. The maximum number of turns for this milestone.", +"format": "int32", +"type": "integer" +}, +"protocol": { +"description": "Optional. The guidelines the agent should follow during the conversation.", +"type": "string" +}, +"staticUtterance": { +"description": "Optional. A static utterance that the simulator will send exactly, instead of dynamically generating user input.", +"type": "string" +}, +"successCriteria": { +"description": "Optional. The success criteria of the milestone.", +"type": "string" +} +}, +"type": "object" +}, "EvaluationScenarioUserFact": { "description": "Facts about the user as a key value pair.", "id": "EvaluationScenarioUserFact", @@ -9630,7 +9754,7 @@ "type": "string" }, "trafficAllocations": { -"description": "Optional. Traffic allocations for the version release.", +"description": "Optional. Traffic allocations for the version release. When non-empty, the `traffic_percentage` values across all allocations must sum to `100`, representing the split of remaining non-study traffic.", "items": { "$ref": "ExperimentConfigVersionReleaseTrafficAllocation" }, @@ -9652,7 +9776,7 @@ "type": "string" }, "trafficPercentage": { -"description": "Optional. Traffic percentage of the traffic allocation. Must be between 0 and 100.", +"description": "Optional. Traffic percentage of the traffic allocation, relative to the remaining non-study traffic. Must be between `0` and `100`.", "format": "int32", "type": "integer" } @@ -9682,7 +9806,7 @@ "type": "string" }, "gcsUri": { -"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified GCS object.", +"description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to which to export the app. The format of this URI must be `gs:///`. The exported app archive will be written directly to the specified Cloud Storage object.", "type": "string" } }, @@ -14423,12 +14547,14 @@ "enum": [ "CLIENT_CAPABILITY_UNSPECIFIED", "CONFIRMATION_CARDS", -"CLIENT_MANAGED_LRO" +"CLIENT_MANAGED_LRO", +"PROJECT_SCOPE" ], "enumDescriptions": [ "Unspecified capability; ignored.", "The client renders AssistantConfirmationRequest cards and answers them via `confirmation_response`.", -"The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline." +"The client manages long-running operations out-of-band by polling the operation and sending `operation_completed_event` to resume the turn. If not declared, the server manages LRO polling and completes the turn inline.", +"The client renders project-scope events: `typed_payload` cards, `target_app` on tool calls and responses, `targets` on confirmation requests and `touched_apps` on turn completion." ], "type": "string" }, @@ -14464,7 +14590,7 @@ "properties": { "artifactChunk": { "$ref": "ArtifactChunk", -"description": "Generated-document artifact event (live preview deltas + final GCS pointer)." +"description": "Generated-document artifact event (live preview deltas + final Cloud Storage pointer)." }, "confirmationRequest": { "$ref": "AssistantConfirmationRequest", @@ -14791,6 +14917,11 @@ "readOnly": true, "type": "string" }, +"targetApp": { +"description": "Output only. The app this call targets, derived by the assistant from the call's resource arguments: an app resource name, `PROJECT` for location-scoped tools, or empty for session-local tools. Set only in project-scoped assistant sessions.", +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" @@ -14862,6 +14993,11 @@ "description": "Required. The tool execution result in JSON object format. Use \"output\" key to specify tool response and \"error\" key to specify error details (if any). If \"output\" and \"error\" keys are not specified, then whole \"response\" is treated as tool execution result.", "type": "object" }, +"targetApp": { +"description": "Output only. The app the executed tool targeted; mirrors ToolCall.target_app.", +"readOnly": true, +"type": "string" +}, "tool": { "description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`", "type": "string" @@ -15126,6 +15262,13 @@ ], "type": "string" }, +"touchedApps": { +"description": "Apps this turn targeted or changed, so the console can refresh exactly those apps' stores. Project-scoped sessions only. Format: `projects/{project}/locations/{location}/apps/{app}`", +"items": { +"type": "string" +}, +"type": "array" +}, "turnId": { "description": "Identifier of the turn that ended; matches TurnResumeSnapshot.turn_id and ActiveTurnInfo.turn_id.", "type": "string" @@ -15218,7 +15361,7 @@ "type": "object" }, "TypedPayload": { -"description": "Payload with a type.", +"description": "Payload with a type. Used by the assistant history (`AssistantChunk`) and by the streaming `typed_payload` event; lives here because both assistant_service.proto and session_service.proto need it.", "id": "TypedPayload", "properties": { "displayName": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 852cfc0c36..7c4cd88798 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -660,7 +660,7 @@ "type": "string" }, "updateMask": { -"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass both description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`", +"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: `space_details`: Updates the space's description and guidelines. You must pass description and guidelines in the update request as `SpaceDetails`. If you only want to update one of the fields, pass the existing value for the other field. `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with `useAdminAccess`. `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with `useAdminAccess`. `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with `useAdminAccess`. `access_settings.access_permission_settings`: Updates the [access permission settings](https://support.google.com/chat/answer/11971020) of who can discover and join the space where `spaceType` field is `SPACE`. Principals allowed to join the space must also be allowed to discover it. To update access permission settings for a space, the authenticating user must be a space manager or assistant manager and omit all other field masks in the request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.access_permission_settings` is not supported with `useAdminAccess`. The supported field masks include: - `access_settings.access_permission_settings.discoverSpaceSetting` - `access_settings.access_permission_settings.joinSpaceSetting` - `access_settings.access_permission_settings.viewSpaceMembershipSetting` `permission_settings`: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space. When updating permission settings, you can only specify `permissionSettings` field masks; you cannot update other field masks at the same time. The supported field masks include: - `permission_settings.manageMembersAndGroups` - `permission_settings.modifySpaceDetails` - `permission_settings.toggleHistory` - `permission_settings.useAtMentionAll` - `permission_settings.manageApps` - `permission_settings.manageWebhooks` - `permission_settings.replyMessages` - `permission_settings.viewSpaceMembership`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2206,6 +2206,40 @@ "https://www.googleapis.com/auth/chat.users.readstate", "https://www.googleapis.com/auth/chat.users.readstate.readonly" ] +}, +"updateThreadReadState": { +"description": "Updates a user's read state within a thread, used to identify read and unread messages. For an example, see [Update a user's thread read state](https://developers.google.com/workspace/chat/update-thread-read-state). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with the [authorization scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.users.readstate`", +"flatPath": "v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState", +"httpMethod": "PATCH", +"id": "chat.users.spaces.threads.updateThreadReadState", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Resource name of the thread read state. Format: `users/{user}/spaces/{space}/threads/{thread}/threadReadState`", +"location": "path", +"pattern": "^users/[^/]+/spaces/[^/]+/threads/[^/]+/threadReadState$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The field paths to update. Currently supported field paths: - `last_read_time` When `last_read_time` is before the latest message create time, the thread appears as unread in the UI. To mark the thread as read, set `last_read_time` to a timestamp equal to or later than the latest message create time. Future timestamps are coerced to the current request time. Setting a negative timestamp (before `1970-01-01T00:00:00Z`) returns an `INVALID_ARGUMENT` error.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "ThreadReadState" +}, +"response": { +"$ref": "ThreadReadState" +}, +"scopes": [ +"https://www.googleapis.com/auth/chat.users.readstate" +] } } } @@ -2214,7 +2248,7 @@ } } }, -"revision": "20261107", +"revision": "20261113", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessPermissionSetting": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 9bfa751bac..07f37ca048 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -136,6 +136,30 @@ "protocol": "rest", "resources": { "customers": { +"methods": { +"getSubscriptionInfo": { +"description": "Gets the aggregated subscription and license information for a given customer as a singleton resource. Note: Because the data is snapshotted for ChromeOS devices, the exact numbers can be delayed by up to 10 seconds.", +"flatPath": "v1/customers/{customersId}/subscriptionInfo", +"httpMethod": "GET", +"id": "chromemanagement.customers.getSubscriptionInfo", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the customer subscription info to retrieve. Format: customers/{customer}/subscriptionInfo", +"location": "path", +"pattern": "^customers/[^/]+/subscriptionInfo$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleChromeManagementVersionsV1SubscriptionInfo" +} +} +}, "resources": { "apps": { "methods": { @@ -2866,7 +2890,7 @@ } } }, -"revision": "20261104", +"revision": "20261112", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -7206,6 +7230,24 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1AnnualSubscriptionInfo": { +"description": "Information for annually recurring subscriptions/licenses.", +"id": "GoogleChromeManagementVersionsV1AnnualSubscriptionInfo", +"properties": { +"counts": { +"$ref": "GoogleChromeManagementVersionsV1LicenseCounts", +"description": "Output only. License counts for this subscription.", +"readOnly": true +}, +"subscriptionEndTime": { +"description": "Output only. The date when the current subscription period ends.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1AttestationCredential": { "description": "Information of public key associated with a Chrome browser profile.", "id": "GoogleChromeManagementVersionsV1AttestationCredential", @@ -8717,6 +8759,31 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1LicenseCounts": { +"description": "Resource counts for a specific license type.", +"id": "GoogleChromeManagementVersionsV1LicenseCounts", +"properties": { +"assignedCount": { +"description": "Output only. Total number of licenses currently assigned to users or devices.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"totalPurchasedCount": { +"description": "Output only. Total number of licenses purchased.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"unassignedCount": { +"description": "Output only. Total number of licenses available for assignment.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ListChromeBrowserProfileCommandsResponse": { "description": "Response to ListChromeBrowserProfileCommands method.", "id": "GoogleChromeManagementVersionsV1ListChromeBrowserProfileCommandsResponse", @@ -8901,6 +8968,30 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1PerpetualLicenseInfo": { +"description": "Information for perpetual licenses.", +"id": "GoogleChromeManagementVersionsV1PerpetualLicenseInfo", +"properties": { +"conditionallyAvailableCount": { +"description": "Output only. Number of standalone perpetual upgrades that were previously enrolled and later unenrolled for RMA, warranty, or repair reasons, and are only available to be reused on a same model device. Conditionally available licenses are a subset of the Assigned total.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"counts": { +"$ref": "GoogleChromeManagementVersionsV1LicenseCounts", +"description": "Output only. License counts for the perpetual SKU.", +"readOnly": true +}, +"retiredCount": { +"description": "Output only. Number of perpetual upgrades that were purchased but are no longer available for enrollment. These are perpetual upgrades that were enrolled to a device that has since been retired, and the upgrade cannot be transferred or re-used on a different device. Retired licenses are a subset of the Assigned total.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1Plugin": { "description": "Information about a Chrome browser plugin installed on a reported Chrome installation on a device with managed Chrome browsers.", "id": "GoogleChromeManagementVersionsV1Plugin", @@ -9724,6 +9815,32 @@ false }, "type": "object" }, +"GoogleChromeManagementVersionsV1SubscriptionInfo": { +"description": "Singleton resource representing the subscription and license information for a given customer.", +"id": "GoogleChromeManagementVersionsV1SubscriptionInfo", +"properties": { +"chromeEnterpriseUpgradeAnnual": { +"$ref": "GoogleChromeManagementVersionsV1AnnualSubscriptionInfo", +"description": "Output only. Details for Chrome Enterprise Upgrade Annual SKU.", +"readOnly": true +}, +"chromePerpetualUpgrade": { +"$ref": "GoogleChromeManagementVersionsV1PerpetualLicenseInfo", +"description": "Output only. Details for Chrome Ent/Edu Upgrade Perpetual SKU.", +"readOnly": true +}, +"kioskSignageUpgradeAnnual": { +"$ref": "GoogleChromeManagementVersionsV1AnnualSubscriptionInfo", +"description": "Output only. Details for Kiosk & Signage Upgrade Annual SKU.", +"readOnly": true +}, +"name": { +"description": "Identifier. The resource name of the customer subscription info. Format: customers/{customer}/subscriptionInfo", +"type": "string" +} +}, +"type": "object" +}, "GoogleChromeManagementVersionsV1ThirdPartyProfileUser": { "description": "A representation of non-Google (third party) user that is associated with a managed Chrome profile.", "id": "GoogleChromeManagementVersionsV1ThirdPartyProfileUser", diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index 04b4f86fa6..6b2ffaba87 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2324,7 +2324,7 @@ } } }, -"revision": "20261029", +"revision": "20261109", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -3091,7 +3091,8 @@ false "type": "string" }, "rankedMachineSeries": { -"description": "Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM.", +"deprecated": true, +"description": "Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect.", "items": { "enum": [ "MACHINE_SERIES_UNSPECIFIED", @@ -4659,7 +4660,8 @@ false }, "privateServiceConnect": { "$ref": "PrivateServiceConnect", -"description": "Immutable. Private Service Connect(PSC) Network configuration for the pool." +"deprecated": true, +"description": "Immutable. Deprecated: Private Service Connect is no longer supported. Private Service Connect(PSC) Network configuration for the pool." }, "workerConfig": { "$ref": "WorkerConfig", @@ -4669,7 +4671,8 @@ false "type": "object" }, "PrivateServiceConnect": { -"description": "Defines the Private Service Connect network configuration for the pool.", +"deprecated": true, +"description": "Deprecated: Private Service Connect is no longer supported. Defines the Private Service Connect network configuration for the pool.", "id": "PrivateServiceConnect", "properties": { "networkAttachment": { @@ -5562,7 +5565,7 @@ false "type": "string" }, "rankedMachineSeries": { -"description": "Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region.", +"description": "Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning worker VMs. The pool's requirements will be matched to a [pre-sized machine type](/compute/docs/general-purpose-machines) which is available in the pool's region. If left blank, Cloud Build will use a sensible default.", "items": { "enum": [ "MACHINE_SERIES_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json index 3fc888d250..60e6ae499a 100644 --- a/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudnumberregistry.v1alpha.json @@ -1735,7 +1735,7 @@ } } }, -"revision": "20260826", +"revision": "20261109", "rootUrl": "https://cloudnumberregistry.googleapis.com/", "schemas": { "AggregatedData": { @@ -1776,7 +1776,7 @@ "type": "object" }, "Attribute": { -"description": "A key-value pair representing a custom attribute associated with a resource.", +"description": "A key-value pair representing a custom attribute associated with a resource. Attributes are resource metadata used to organize and search for resources. Do not include sensitive information, such as personally identifiable information or credentials, in attribute `key` or `value`.", "id": "Attribute", "properties": { "key": { @@ -1833,7 +1833,7 @@ "type": "array" }, "description": { -"description": "Optional. The description of the CustomRange.", +"description": "Optional. The description of the CustomRange. Do not include sensitive information, such as personally identifiable information or credentials, in the `description` field.", "type": "string" }, "ipv4CidrRange": { @@ -2192,7 +2192,7 @@ true "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2217,7 +2217,7 @@ true "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2242,7 +2242,7 @@ true "type": "string" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2310,7 +2310,7 @@ true "type": "array" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2335,7 +2335,7 @@ true "type": "array" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2360,7 +2360,7 @@ true "type": "array" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, @@ -2820,7 +2820,7 @@ true "type": "array" }, "unreachable": { -"description": "Locations that could not be reached.", +"description": "Unordered list. Locations that could not be reached.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index c966742374..19bfb8f04c 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -58444,7 +58444,7 @@ } } }, -"revision": "20261026", +"revision": "20261106", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -63643,7 +63643,7 @@ false "id": "BackendServiceHAPolicy", "properties": { "fastIPMove": { -"description": "Specifies whether fast IP move is enabled, and if so, the mechanism to\nachieve it.\n\nSupported values are:\n \n - DISABLED: Fast IP Move is disabled. You can only use the\n haPolicy.leader API to update the leader.\n - >GARP_RA: Provides a method to very quickly define a new network\n endpoint as the leader. This method is faster than updating the leader\n using the haPolicy.leader API. Fast IP move works as follows: The VM\n hosting the network endpoint that should become the new leader sends\n either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router\n Advertisement(RA) packet (IPv6). Google Cloud immediately but\n temporarily associates the forwarding rule IP address with that VM, and\n both new and in-flight packets are quickly delivered to that VM.\n - HA_CONTROLLER: The Backend Service is managed by a High Availability\n Controller. Failover and leader election are exclusively managed by the\n HA Controller service.\n\n\n\nNote the important properties of the Fast IP Move functionality:\n \n - The GARP/RA-initiated re-routing stays active for approximately 20\n minutes. After triggering fast failover, you must also\n appropriately set the haPolicy.leader.\n - The new leader instance should continue to send GARP/RA packets\n periodically every 10 seconds until at least 10 minutes after updating\n the haPolicy.leader (but stop immediately if it is no longer the leader).\n - After triggering a fast failover, we recommend that you wait at least\n 3 seconds before sending another GARP/RA packet from a different VM\n instance to avoid race conditions.\n - Don't send GARP/RA packets from different VM\n instances at the same time. If multiple instances continue to send\n GARP/RA packets, traffic might be routed to different destinations in an\n alternating order. This condition ceases when a single instance\n issues a GARP/RA packet.\n - The GARP/RA request always takes priority over the leader API.\n Using the haPolicy.leader API to change the leader to a different\n instance will have no effect until the GARP/RA request becomes\n inactive.\n - The GARP/RA packets should follow the GARP/RA\n Packet Specifications..\n - When multiple forwarding rules refer to a regional backend service,\n you need only send a GARP or RA packet for a single forwarding rule\n virtual IP. The virtual IPs for all forwarding rules targeting the same\n backend service will also be moved to the sender of the GARP or RA\n packet. \n\n\n\nThe following are the Fast IP Move limitations (that is, when fastIPMove\nis not DISABLED):\n \n - Multiple forwarding rules cannot use the same IP address if one of\n them refers to a regional backend service with fastIPMove.\n - The regional backend service must set the network field, and all\n NEGs must belong to that network. However, individual\n NEGs can belong to different subnetworks of that network. \n - The maximum number of network endpoints across all backends of a\n backend service with fastIPMove is 32.\n - The maximum number of backend services with fastIPMove that can have\n the same network endpoint attached to one of its backends is 64.\n - The maximum number of backend services with fastIPMove in a VPC in a\n region is 64.\n - The network endpoints that are attached to a backend of a backend\n service with fastIPMove cannot resolve to Gen3+ machines for IPv6.\n - Traffic directed to the leader by a static route next hop will not be\n redirected to a new leader by fast failover. Such traffic will only be\n redirected once an haPolicy.leader update has taken effect. Only traffic\n to the forwarding rule's virtual IP will be redirected to a new leader by\n fast failover.\n\n\nhaPolicy.fastIPMove can be set only at backend service creation time.\nOnce set, it cannot be updated.\n\nBy default, fastIpMove is set to DISABLED.", +"description": "Specifies whether fast IP move is enabled, and if so, the mechanism to\nachieve it.\n\nSupported values are:\n \n - DISABLED: Fast IP Move is disabled. You can only use the\n haPolicy.leader API to update the leader.\n - >GARP_RA: Provides a method to very quickly define a new network\n endpoint as the leader. This method is faster than updating the leader\n using the haPolicy.leader API. Fast IP move works as follows: The VM\n hosting the network endpoint that should become the new leader sends\n either a Gratuitous ARP (GARP) packet (IPv4) or an ICMPv6 Router\n Advertisement(RA) packet (IPv6). Google Cloud immediately but\n temporarily associates the forwarding rule IP address with that VM, and\n both new and in-flight packets are quickly delivered to that VM.\n\n\n\nNote the important properties of the Fast IP Move functionality:\n \n - The GARP/RA-initiated re-routing stays active for approximately 20\n minutes. After triggering fast failover, you must also\n appropriately set the haPolicy.leader.\n - The new leader instance should continue to send GARP/RA packets\n periodically every 10 seconds until at least 10 minutes after updating\n the haPolicy.leader (but stop immediately if it is no longer the leader).\n - After triggering a fast failover, we recommend that you wait at least\n 3 seconds before sending another GARP/RA packet from a different VM\n instance to avoid race conditions.\n - Don't send GARP/RA packets from different VM\n instances at the same time. If multiple instances continue to send\n GARP/RA packets, traffic might be routed to different destinations in an\n alternating order. This condition ceases when a single instance\n issues a GARP/RA packet.\n - The GARP/RA request always takes priority over the leader API.\n Using the haPolicy.leader API to change the leader to a different\n instance will have no effect until the GARP/RA request becomes\n inactive.\n - The GARP/RA packets should follow the GARP/RA\n Packet Specifications..\n - When multiple forwarding rules refer to a regional backend service,\n you need only send a GARP or RA packet for a single forwarding rule\n virtual IP. The virtual IPs for all forwarding rules targeting the same\n backend service will also be moved to the sender of the GARP or RA\n packet. \n\n\n\nThe following are the Fast IP Move limitations (that is, when fastIPMove\nis not DISABLED):\n \n - Multiple forwarding rules cannot use the same IP address if one of\n them refers to a regional backend service with fastIPMove.\n - The regional backend service must set the network field, and all\n NEGs must belong to that network. However, individual\n NEGs can belong to different subnetworks of that network. \n - The maximum number of network endpoints across all backends of a\n backend service with fastIPMove is 32.\n - The maximum number of backend services with fastIPMove that can have\n the same network endpoint attached to one of its backends is 64.\n - The maximum number of backend services with fastIPMove in a VPC in a\n region is 64.\n - The network endpoints that are attached to a backend of a backend\n service with fastIPMove cannot resolve to Gen3+ machines for IPv6.\n - Traffic directed to the leader by a static route next hop will not be\n redirected to a new leader by fast failover. Such traffic will only be\n redirected once an haPolicy.leader update has taken effect. Only traffic\n to the forwarding rule's virtual IP will be redirected to a new leader by\n fast failover.\n\n\nhaPolicy.fastIPMove can be set only at backend service creation time.\nOnce set, it cannot be updated.\n\nBy default, fastIpMove is set to DISABLED.", "enum": [ "DISABLED", "GARP_RA" @@ -65516,7 +65516,7 @@ false "id": "CapacityAdviceRequestInstancePropertiesScheduling", "properties": { "maxRunDuration": { -"description": "The maximum time that instances can run before Compute Engine\nterminates them.", +"description": "Optional. The maximum time that instances can run before Compute Engine\nterminates them. If you set the `provisioning_model` to `FLEX_START`,\nthen Compute Engine requires this duration, and the value must be\nbetween 10 minutes and 7 days.", "format": "google-duration", "type": "string" }, @@ -65581,7 +65581,7 @@ false "type": "string" }, "estimatedWaitDuration": { -"description": "Output only. The likely maximum time that you will have to wait until\nCompute Engine provisions your instances.", +"description": "Output only. The estimated time you have to wait before Compute Engine provisions\nyour instances. The value 999999999s indicates that the wait time is\nunknown or very long.", "format": "google-duration", "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 8bf7f142db..fa8a16fa99 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -416,6 +416,48 @@ "https://www.googleapis.com/auth/cloud-platform" ] } +}, +"resources": { +"phoneNumbers": { +"methods": { +"list": { +"description": "Lists phone numbers allocated to a single ContactCenter.", +"flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/contactCenters/{contactCentersId}/phoneNumbers", +"httpMethod": "GET", +"id": "contactcenteraiplatform.projects.locations.contactCenters.phoneNumbers.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the default page size is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from a previous ListPhoneNumbers call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent ContactCenter resource name. Format: projects/{project}/locations/{location}/contactCenters/{contact_center}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/contactCenters/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha1/{+parent}/phoneNumbers", +"response": { +"$ref": "ListPhoneNumbersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} } }, "operations": { @@ -551,7 +593,7 @@ } } }, -"revision": "20260423", +"revision": "20261104", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -1140,6 +1182,24 @@ }, "type": "object" }, +"ListPhoneNumbersResponse": { +"description": "Response message for ListPhoneNumbers.", +"id": "ListPhoneNumbersResponse", +"properties": { +"nextPageToken": { +"description": "Token identifying the next page of results.", +"type": "string" +}, +"phoneNumbers": { +"description": "The list of phone numbers allocated to the ContactCenter.", +"items": { +"$ref": "PhoneNumber" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -1263,6 +1323,140 @@ }, "type": "object" }, +"PhoneNumber": { +"description": "Message describing a phone number allocated to a ContactCenter tenant.", +"id": "PhoneNumber", +"properties": { +"assignmentState": { +"description": "Output only. Current assignment and lifecycle state.", +"enum": [ +"ASSIGNMENT_STATE_UNSPECIFIED", +"ASSIGNMENT_STATE_UNASSIGNED", +"ASSIGNMENT_STATE_ASSIGNED", +"ASSIGNMENT_STATE_COOLING_OFF", +"ASSIGNMENT_STATE_PORTING_IN", +"ASSIGNMENT_STATE_RELEASED" +], +"enumDescriptions": [ +"Unspecified assignment state.", +"Unassigned / in inventory pool.", +"Actively assigned to the tenant.", +"Soft-deleted / in cooling-off period (still billed).", +"Port-in in progress.", +"Permanently released from active use." +], +"readOnly": true, +"type": "string" +}, +"carrier": { +"description": "Output only. Underlying carrier hosting the number.", +"enum": [ +"CARRIER_UNSPECIFIED", +"CARRIER_TWILIO", +"CARRIER_VONAGE", +"CARRIER_TELNYX", +"CARRIER_GTP" +], +"enumDescriptions": [ +"Unspecified carrier.", +"Twilio carrier.", +"Vonage (Nexmo) carrier.", +"Telnyx carrier.", +"Google Telephony Platform (GTP) carrier." +], +"readOnly": true, +"type": "string" +}, +"complianceState": { +"description": "Output only. Regulatory compliance state.", +"enum": [ +"COMPLIANCE_STATE_UNSPECIFIED", +"COMPLIANCE_STATE_VERIFIED", +"COMPLIANCE_STATE_LEGACY_VERIFIED", +"COMPLIANCE_STATE_PENDING", +"COMPLIANCE_STATE_REJECTED" +], +"enumDescriptions": [ +"Unspecified compliance state.", +"Regulatory bundle verified and approved.", +"Pre-existing phone number exempt from document backfill.", +"Regulatory bundle pending review.", +"Regulatory bundle rejected." +], +"readOnly": true, +"type": "string" +}, +"countryCode": { +"description": "Output only. ISO 3166-1 alpha-2 country code (e.g., \"US\", \"GB\", \"IT\").", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Timestamp when the phone number was added to the tenant.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"numberType": { +"description": "Output only. Tariff and routing classification.", +"enum": [ +"NUMBER_TYPE_UNSPECIFIED", +"NUMBER_TYPE_LOCAL", +"NUMBER_TYPE_TOLL_FREE", +"NUMBER_TYPE_MOBILE", +"NUMBER_TYPE_NATIONAL" +], +"enumDescriptions": [ +"Unspecified number type.", +"Local / geographic number.", +"Toll-free number.", +"Mobile number.", +"National non-geographic number." +], +"readOnly": true, +"type": "string" +}, +"phoneNumber": { +"description": "Output only. E.164 formatted phone number (e.g., \"+16502530000\").", +"readOnly": true, +"type": "string" +}, +"regulatoryBundleId": { +"description": "Output only. Reference ID for the country-specific regulatory bundle, or \"LEGACY_VERIFIED\".", +"readOnly": true, +"type": "string" +}, +"smsState": { +"description": "Output only. SMS capability state.", +"enum": [ +"SMS_STATE_UNSPECIFIED", +"SMS_STATE_DISABLED", +"SMS_STATE_ENABLED", +"SMS_STATE_PENDING_REGISTRATION" +], +"enumDescriptions": [ +"Unspecified SMS state.", +"SMS is disabled.", +"SMS is enabled and active.", +"SMS is pending campaign registration." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp when the phone number record was last modified.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"voiceEnabled": { +"description": "Output only. Whether voice capabilities are enabled for this phone number.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "PlanningHorizon": { "description": "Specifies the time interval during which the solver should generate shifts. The start time must be before the end time.", "id": "PlanningHorizon", diff --git a/googleapiclient/discovery_cache/documents/dataform.v1.json b/googleapiclient/discovery_cache/documents/dataform.v1.json index 3bcdfb54eb..e5b85be991 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1.json @@ -2205,6 +2205,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"createLongRunning": { +"description": "Creates a new Workspace in a given Repository asynchronously.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces:createLongRunning", +"httpMethod": "POST", +"id": "dataform.projects.locations.repositories.workspaces.createLongRunning", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The repository in which to create the workspace. Must be in the format `projects/*/locations/*/repositories/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/repositories/[^/]+$", +"required": true, +"type": "string" +}, +"workspaceId": { +"description": "Required. The ID to use for the workspace, which will become the final component of the workspace's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/workspaces:createLongRunning", +"request": { +"$ref": "Workspace" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/bigquery", +"https://www.googleapis.com/auth/cloud-platform" +] +}, "delete": { "description": "Deletes a single Workspace.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/repositories/{repositoriesId}/workspaces/{workspacesId}", @@ -3249,7 +3283,7 @@ } } }, -"revision": "20261030", +"revision": "20261108", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 4e684ba3a8..610f559c21 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1493,7 +1493,7 @@ } } }, -"revision": "20260923", +"revision": "20261105", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -1864,7 +1864,7 @@ }, "postgresqlProfile": { "$ref": "PostgresqlProfile", -"description": "Profile for connecting to a PostgreSQL source." +"description": "Profile for connecting to a PostgreSQL source or destination." }, "privateConnectivity": { "$ref": "PrivateConnectivity", @@ -3660,7 +3660,7 @@ "type": "object" }, "PostgresqlProfile": { -"description": "Profile for connecting to a PostgreSQL source.", +"description": "Profile for connecting to a PostgreSQL source or destination.", "id": "PostgresqlProfile", "properties": { "database": { diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json index 465a8de464..b89312e3b1 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.alpha.json @@ -1676,7 +1676,7 @@ } } }, -"revision": "20260827", +"revision": "20261112", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1816,6 +1816,12 @@ "format": "int32", "type": "integer" }, +"estimatedAvailabilityTime": { +"description": "Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "failedToCreateVmCount": { "description": "[Output Only] Count of VMs that started creating but encountered an error.", "format": "int32", @@ -2362,12 +2368,41 @@ "GetVersionOperationMetadata": { "id": "GetVersionOperationMetadata", "properties": { +"inlineHbomInfo": { +"$ref": "GetVersionOperationMetadataHbomInfo" +}, "inlineSbomInfo": { "$ref": "GetVersionOperationMetadataSbomInfo" } }, "type": "object" }, +"GetVersionOperationMetadataHbomInfo": { +"id": "GetVersionOperationMetadataHbomInfo", +"properties": { +"hardwareComponentInfo": { +"additionalProperties": { +"$ref": "GetVersionOperationMetadataHbomInfoComponentValues" +}, +"description": "A mapping of hardware sub-component categories to their component values.", +"type": "object" +} +}, +"type": "object" +}, +"GetVersionOperationMetadataHbomInfoComponentValues": { +"id": "GetVersionOperationMetadataHbomInfoComponentValues", +"properties": { +"values": { +"description": "List of obfuscated hardware component identifiers.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GetVersionOperationMetadataSbomInfo": { "id": "GetVersionOperationMetadataSbomInfo", "properties": { @@ -2635,6 +2670,99 @@ }, "type": "object" }, +"MicroVmsExportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.export.", +"id": "MicroVmsExportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the exported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Target Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred to Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files archived.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Target Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MicroVmsImportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.import.", +"id": "MicroVmsImportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the imported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Source Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred from Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files imported.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Source Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +}, +"phase": { +"description": "Output only. [Output Only] The current phase of the import operation.", +"enum": [ +"PHASE_UNSPECIFIED", +"SCHEDULING", +"PROVISIONING_STORAGE", +"IMPORTING", +"BOOTING" +], +"enumDescriptions": [ +"Default value; not used.", +"Selecting a host and reserving capacity for the MicroVM.", +"Creating and attaching the MicroVM's persistent session storage.", +"Streaming user data from Cloud Storage into the session storage.", +"Booting the guest VM." +], +"readOnly": true, +"type": "string" +}, +"totalBytes": { +"description": "Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.", "id": "Operation", @@ -2771,6 +2899,16 @@ "readOnly": true, "type": "string" }, +"microVmsExportOperationMetadata": { +"$ref": "MicroVmsExportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.export.", +"readOnly": true +}, +"microVmsImportOperationMetadata": { +"$ref": "MicroVmsImportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.import.", +"readOnly": true +}, "name": { "description": "[Output Only] Name of the operation.", "type": "string" @@ -2888,8 +3026,8 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -2974,11 +3112,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -3296,8 +3434,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -3382,11 +3520,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -3620,8 +3758,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -3706,11 +3844,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json index b44db6d018..728486a3da 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2.json @@ -1028,7 +1028,7 @@ } } }, -"revision": "20260827", +"revision": "20261112", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { @@ -1114,6 +1114,12 @@ "format": "int32", "type": "integer" }, +"estimatedAvailabilityTime": { +"description": "Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "failedToCreateVmCount": { "description": "[Output Only] Count of VMs that started creating but encountered an error.", "format": "int32", @@ -1476,12 +1482,41 @@ "GetVersionOperationMetadata": { "id": "GetVersionOperationMetadata", "properties": { +"inlineHbomInfo": { +"$ref": "GetVersionOperationMetadataHbomInfo" +}, "inlineSbomInfo": { "$ref": "GetVersionOperationMetadataSbomInfo" } }, "type": "object" }, +"GetVersionOperationMetadataHbomInfo": { +"id": "GetVersionOperationMetadataHbomInfo", +"properties": { +"hardwareComponentInfo": { +"additionalProperties": { +"$ref": "GetVersionOperationMetadataHbomInfoComponentValues" +}, +"description": "A mapping of hardware sub-component categories to their component values.", +"type": "object" +} +}, +"type": "object" +}, +"GetVersionOperationMetadataHbomInfoComponentValues": { +"id": "GetVersionOperationMetadataHbomInfoComponentValues", +"properties": { +"values": { +"description": "List of obfuscated hardware component identifiers.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GetVersionOperationMetadataSbomInfo": { "id": "GetVersionOperationMetadataSbomInfo", "properties": { @@ -1685,6 +1720,99 @@ }, "type": "object" }, +"MicroVmsExportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.export.", +"id": "MicroVmsExportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the exported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Target Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred to Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files archived.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Target Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MicroVmsImportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.import.", +"id": "MicroVmsImportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the imported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Source Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred from Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files imported.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Source Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +}, +"phase": { +"description": "Output only. [Output Only] The current phase of the import operation.", +"enum": [ +"PHASE_UNSPECIFIED", +"SCHEDULING", +"PROVISIONING_STORAGE", +"IMPORTING", +"BOOTING" +], +"enumDescriptions": [ +"Default value; not used.", +"Selecting a host and reserving capacity for the MicroVM.", +"Creating and attaching the MicroVM's persistent session storage.", +"Streaming user data from Cloud Storage into the session storage.", +"Booting the guest VM." +], +"readOnly": true, +"type": "string" +}, +"totalBytes": { +"description": "Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.", "id": "Operation", @@ -1821,6 +1949,16 @@ "readOnly": true, "type": "string" }, +"microVmsExportOperationMetadata": { +"$ref": "MicroVmsExportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.export.", +"readOnly": true +}, +"microVmsImportOperationMetadata": { +"$ref": "MicroVmsImportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.import.", +"readOnly": true +}, "name": { "description": "[Output Only] Name of the operation.", "type": "string" @@ -1938,8 +2076,8 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -2024,11 +2162,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -2265,8 +2403,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -2351,11 +2489,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -2566,8 +2704,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -2652,11 +2790,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json index 643bbec65a..5b168b0fba 100644 --- a/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json +++ b/googleapiclient/discovery_cache/documents/deploymentmanager.v2beta.json @@ -1636,7 +1636,7 @@ } } }, -"revision": "20260827", +"revision": "20261112", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AsyncOptions": { @@ -1776,6 +1776,12 @@ "format": "int32", "type": "integer" }, +"estimatedAvailabilityTime": { +"description": "Output only. [Output Only] The time when the scheduler expects capacity for this location. The field is set only while the status is PENDING. The value 9999-12-31T23:59:59.999999999Z means that the scheduler expects no capacity. The field is absent when the scheduler gives no estimate, and it is cleared when the status changes.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, "failedToCreateVmCount": { "description": "[Output Only] Count of VMs that started creating but encountered an error.", "format": "int32", @@ -2288,12 +2294,41 @@ "GetVersionOperationMetadata": { "id": "GetVersionOperationMetadata", "properties": { +"inlineHbomInfo": { +"$ref": "GetVersionOperationMetadataHbomInfo" +}, "inlineSbomInfo": { "$ref": "GetVersionOperationMetadataSbomInfo" } }, "type": "object" }, +"GetVersionOperationMetadataHbomInfo": { +"id": "GetVersionOperationMetadataHbomInfo", +"properties": { +"hardwareComponentInfo": { +"additionalProperties": { +"$ref": "GetVersionOperationMetadataHbomInfoComponentValues" +}, +"description": "A mapping of hardware sub-component categories to their component values.", +"type": "object" +} +}, +"type": "object" +}, +"GetVersionOperationMetadataHbomInfoComponentValues": { +"id": "GetVersionOperationMetadataHbomInfoComponentValues", +"properties": { +"values": { +"description": "List of obfuscated hardware component identifiers.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GetVersionOperationMetadataSbomInfo": { "id": "GetVersionOperationMetadataSbomInfo", "properties": { @@ -2534,6 +2569,99 @@ }, "type": "object" }, +"MicroVmsExportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.export.", +"id": "MicroVmsExportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the exported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Target Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred to Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files archived.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Target Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MicroVmsImportOperationMetadata": { +"description": "[Output Only] Operation metadata for microVms.import.", +"id": "MicroVmsImportOperationMetadata", +"properties": { +"archiveSha256": { +"description": "Output only. [Output Only] SHA-256 hex digest of the imported archive.", +"readOnly": true, +"type": "string" +}, +"bucketName": { +"description": "Output only. [Output Only] Source Cloud Storage bucket name.", +"readOnly": true, +"type": "string" +}, +"bytesTransferred": { +"description": "Output only. [Output Only] Total bytes transferred from Cloud Storage.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"filesTransferred": { +"description": "Output only. [Output Only] Total files imported.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"objectName": { +"description": "Output only. [Output Only] Source Cloud Storage object name or prefix.", +"readOnly": true, +"type": "string" +}, +"phase": { +"description": "Output only. [Output Only] The current phase of the import operation.", +"enum": [ +"PHASE_UNSPECIFIED", +"SCHEDULING", +"PROVISIONING_STORAGE", +"IMPORTING", +"BOOTING" +], +"enumDescriptions": [ +"Default value; not used.", +"Selecting a host and reserving capacity for the MicroVM.", +"Creating and attaching the MicroVM's persistent session storage.", +"Streaming user data from Cloud Storage into the session storage.", +"Booting the guest VM." +], +"readOnly": true, +"type": "string" +}, +"totalBytes": { +"description": "Output only. [Output Only] Size of the source object in bytes. Unset for DIRECTORY_SYNC.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Operation": { "description": "Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.", "id": "Operation", @@ -2670,6 +2798,16 @@ "readOnly": true, "type": "string" }, +"microVmsExportOperationMetadata": { +"$ref": "MicroVmsExportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.export.", +"readOnly": true +}, +"microVmsImportOperationMetadata": { +"$ref": "MicroVmsImportOperationMetadata", +"description": "Output only. [Output Only] Operation metadata for microVms.import.", +"readOnly": true +}, "name": { "description": "[Output Only] Name of the operation.", "type": "string" @@ -2787,8 +2925,8 @@ "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -2873,11 +3011,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -3172,8 +3310,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -3258,11 +3396,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" @@ -3473,8 +3611,8 @@ false "QUOTA_INFO_UNAVAILABLE", "RESOURCE_USES_GLOBAL_DNS", "RATE_LIMIT_EXCEEDED", +"ASYNC_REPLICATION_SECONDARY_UPDATE_PENDING", "UPCOMING_MAINTENANCES_UNAVAILABLE", -"RESERVED_ENTRY_136", "RESERVED_ENTRY_139", "RESERVED_ENTRY_141", "RESERVED_ENTRY_142", @@ -3559,11 +3697,11 @@ false "Quota information is not available to client requests (e.g: regions.list).", "Indicates that a VM is using global DNS. Can also be used to indicate that a resource has attributes that could result in the creation of a VM that uses global DNS.", "Resource can't be retrieved due to api quota exceeded.", +"Primary disk resized. Secondary disk resize is in-progress and awaiting resource allocation in the secondary region.", "Upcoming maintenance schedule is unavailable for the resource.", "Reserved entries for quickly adding new warnings without breaking dependent clients.", "", "", -"", "" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index f3f603ab49..bbfbc3dbde 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -18,6 +18,11 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://developerconnect.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://developerconnect.asia-east1.rep.googleapis.com/", "location": "asia-east1" }, @@ -168,6 +173,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://developerconnect.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://developerconnect.southamerica-east1.rep.googleapis.com/", "location": "southamerica-east1" }, @@ -1353,7 +1363,7 @@ "type": "string" }, "name": { -"description": "Required. The resource name of the GitRepositoryLink.", +"description": "Required. The resource name of the GitRepositoryLink in the format `projects/*/locations/*/connections/*/gitRepositoryLinks/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/connections/[^/]+/gitRepositoryLinks/[^/]+$", "required": true, @@ -2343,7 +2353,7 @@ } } }, -"revision": "20261025", +"revision": "20261109", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -2430,10 +2440,10 @@ "properties": { "comment": { "$ref": "PullRequestReviewComment", -"description": "Required. The review comment to add." +"description": "Required. The review comment to add. Input fields used: `body`, `path`, `first_line`, `last_line`, `side`." }, "commitId": { -"description": "Optional. The commit SHA to comment on. If not specified, defaults to the HEAD commit of the Pull Request.", +"description": "Optional. The SHA of a commit in the pull request to comment on. If not specified, defaults to the HEAD commit of the pull request. Set this only to comment on a specific, known commit in the pull request.", "type": "string" }, "pullRequestId": { @@ -4258,7 +4268,7 @@ "type": "string" }, "baseRef": { -"description": "Required. The target commit SHA of the base branch.", +"description": "Required. The name of the target (base) branch that the changes are merged into.", "type": "string" }, "body": { @@ -4284,7 +4294,7 @@ "type": "string" }, "headRef": { -"description": "Required. The source commit SHA of the head branch.", +"description": "Required. The name of the source (head) branch that contains the changes.", "type": "string" }, "htmlUrl": { @@ -4293,7 +4303,7 @@ "type": "string" }, "id": { -"description": "Required. The ID of the PR.", +"description": "Optional. The ID of the PR, assigned by the SCM provider (for example, \"45\"). Ignored by `OpenGitRepositoryLinkPullRequest`.", "type": "string" }, "mergeTime": { @@ -4398,7 +4408,7 @@ "type": "string" }, "commitId": { -"description": "Output only. The commit SHA the comment was actually applied to.", +"description": "Output only. The commit SHA the comment was actually applied to. Ignored in requests; to choose the commit to comment on, set `AddGitRepositoryLinkPullRequestReviewCommentRequest.commit_id`.", "readOnly": true, "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 1ee1cd3bb1..7f9139cffd 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -1200,13 +1200,410 @@ ] } } +}, +"volumePools": { +"methods": { +"create": { +"description": "Creates a volume pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools", +"httpMethod": "POST", +"id": "file.projects.locations.volumePools.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The project and location for which to create the volume pool, in the format `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"volumePoolId": { +"description": "Required. The ID to use for the volume pool, which will become the final component of the volume pool's resource name.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/volumePools", +"request": { +"$ref": "VolumePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a volume pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}", +"httpMethod": "DELETE", +"id": "file.projects.locations.volumePools.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"force": { +"description": "Optional. If set to `true`, the volume pool is deleted even if it has volumes, and its volumes are deleted with it. Otherwise, the request fails if the volume pool has any volumes.", +"location": "query", +"type": "boolean" +}, +"name": { +"description": "Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the details of a specific volume pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}", +"httpMethod": "GET", +"id": "file.projects.locations.volumePools.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The volume pool resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "VolumePool" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all volume pools in a project for either a specified location or for all locations.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools", +"httpMethod": "GET", +"id": "file.projects.locations.volumePools.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location for which to retrieve volume pool information, in the format `projects/{project}/locations/{location}`. To retrieve volume pool information for all locations, use \"-\" as the value of `{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/volumePools", +"response": { +"$ref": "ListVolumePoolsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific volume pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}", +"httpMethod": "PATCH", +"id": "file.projects.locations.volumePools.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "VolumePool" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"volumes": { +"methods": { +"create": { +"description": "Creates a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes", +"httpMethod": "POST", +"id": "file.projects.locations.volumePools.volumes.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent volume pool path, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +}, +"volumeId": { +"description": "Required. The ID to use for the volume. The ID must be unique within the specified volume pool.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/volumes", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Volume" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"createFromSource": { +"description": "Creates a volume in a volume pool from an existing data source (such as a Filestore backup).", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes:createFromSource", +"httpMethod": "POST", +"id": "file.projects.locations.volumePools.volumes.createFromSource", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this volume will be created. Format: projects/{project}/locations/{location}/volumePools/{volume_pool}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/volumes:createFromSource", +"request": { +"$ref": "CreateFromSourceRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}", +"httpMethod": "DELETE", +"id": "file.projects.locations.volumePools.volumes.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets the details of a specific volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}", +"httpMethod": "GET", +"id": "file.projects.locations.volumePools.volumes.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The volume resource name, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Volume" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists all volumes for a specified volume pool.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes", +"httpMethod": "GET", +"id": "file.projects.locations.volumePools.volumes.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. List filter.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sort results. Supported values are \"name\", \"name desc\" or \"\" (unsorted).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of items to return.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The next_page_token value to use if there are additional results to retrieve for this list request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The volume pool for which to retrieve volume information, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/volumes", +"response": { +"$ref": "ListVolumesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the settings of a specific volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}", +"httpMethod": "PATCH", +"id": "file.projects.locations.volumePools.volumes.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. Mask of fields to update. At least one path must be supplied in this field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "Volume" +}, +"response": { +"$ref": "Volume" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"unfreeze": { +"description": "Unfreezes a volume.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/volumePools/{volumePoolsId}/volumes/{volumesId}:unfreeze", +"httpMethod": "POST", +"id": "file.projects.locations.volumePools.volumes.unfreeze", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the volume to unfreeze. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/volumePools/[^/]+/volumes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:unfreeze", +"request": { +"$ref": "UnfreezeVolumeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} } } } } } }, -"revision": "20260819", +"revision": "20261109", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1354,6 +1751,37 @@ "properties": {}, "type": "object" }, +"CreateFromSourceRequest": { +"description": "Request for creating a volume from an existing data source (such as a backup).", +"id": "CreateFromSourceRequest", +"properties": { +"backup": { +"description": "The resource name of the backup to create from. Format: projects/{project}/locations/{location}/backups/{backup}", +"type": "string" +}, +"ipAcls": { +"description": "Optional. IP ACLs defining permissions/ACLs to apply to the newly created volume.", +"items": { +"$ref": "NfsExportOptions" +}, +"type": "array" +}, +"quota": { +"description": "Optional. The limit for how much data can be written to this volume, in MiB.", +"format": "int64", +"type": "string" +}, +"requestId": { +"description": "Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.", +"type": "string" +}, +"volumeId": { +"description": "Required. Unique identifier for the volume which also appears in the volumes resource name.", +"type": "string" +} +}, +"type": "object" +}, "DailyCycle": { "description": "Time window specified for daily operations.", "id": "DailyCycle", @@ -2116,6 +2544,56 @@ }, "type": "object" }, +"ListVolumePoolsResponse": { +"description": "ListVolumePoolsResponse is the result of ListVolumePoolsRequest.", +"id": "ListVolumePoolsResponse", +"properties": { +"nextPageToken": { +"description": "Optional. The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"volumePools": { +"description": "Unordered list. A list of volume pools in the project for the specified location.", +"items": { +"$ref": "VolumePool" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListVolumesResponse": { +"description": "ListVolumesResponse is the result of ListVolumesRequest.", +"id": "ListVolumesResponse", +"properties": { +"nextPageToken": { +"description": "Optional. The token you can use to retrieve the next page of results. Not returned if there are no more results in the list.", +"type": "string" +}, +"unreachable": { +"description": "Unordered list. Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +}, +"volumes": { +"description": "Unordered list. A list of volumes in the project for the specified volume pool.", +"items": { +"$ref": "Volume" +}, +"type": "array" +} +}, +"type": "object" +}, "Location": { "description": "A resource that represents a Google Cloud location.", "id": "Location", @@ -2215,6 +2693,23 @@ }, "type": "object" }, +"MountPoint": { +"description": "Mount details for a volume.", +"id": "MountPoint", +"properties": { +"ipAddress": { +"description": "Output only. The IP address of the physical Filestore instance hosting the volume.", +"readOnly": true, +"type": "string" +}, +"mountName": { +"description": "Output only. The mount name of the volume. Must be 63 characters or less and consist of uppercase or lowercase letters, numbers, and underscores.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "NetworkConfig": { "description": "Network configuration for the instance.", "id": "NetworkConfig", @@ -2779,6 +3274,29 @@ }, "type": "object" }, +"UnfreezeVolumeRequest": { +"description": "Request for unfreezing a volume.", +"id": "UnfreezeVolumeRequest", +"properties": { +"ipAcls": { +"description": "Optional. IP ACLs defining permissions/ACLs to apply to the unfrozen volume", +"items": { +"$ref": "NfsExportOptions" +}, +"type": "array" +}, +"quota": { +"description": "Optional. The limit for how much data can be written to this volume, in MiB.", +"format": "int64", +"type": "string" +}, +"requestId": { +"description": "Optional. A unique ID used to identify the request, so retries are idempotent. Must be a valid UUID4; the zero UUID (`00000000-0000-0000-0000-000000000000`) is not supported.", +"type": "string" +} +}, +"type": "object" +}, "UpdatePolicy": { "description": "Maintenance policy applicable to instance updates.", "id": "UpdatePolicy", @@ -2817,6 +3335,143 @@ }, "type": "object" }, +"Volume": { +"description": "Volume representation of a Cloud Filestore volume.", +"id": "Volume", +"properties": { +"createTime": { +"description": "Output only. The time when the volume was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A description of the volume with 2048 characters or less. Requests with longer descriptions will be rejected.", +"type": "string" +}, +"ipAcls": { +"description": "Optional. User-defined permissions protecting mount points.", +"items": { +"$ref": "NfsExportOptions" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata.", +"type": "object" +}, +"mountPoint": { +"$ref": "MountPoint", +"description": "Output only. The mount point of the volume.", +"readOnly": true +}, +"name": { +"description": "Identifier. The resource name of the volume, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`.", +"type": "string" +}, +"quotaMib": { +"description": "Optional. The maximum size of the volume in mebibytes (MiB).", +"format": "int64", +"type": "string" +}, +"state": { +"description": "Optional. The state of the volume. This field is caller-settable via `UpdateVolume` to transition a volume from `HOT` to `COLD` (freezing the volume). In `CreateVolume`, this field is output-only: the volume is created as `HOT` when `ip_acls` is non-empty. When `ip_acls` is empty, the volume may be created `WARM` with no `mount_point` until `ip_acls` are set with `UpdateVolume`.", +"enum": [ +"STATE_UNSPECIFIED", +"CREATING", +"HOT", +"WARM", +"COLD" +], +"enumDescriptions": [ +"The state of the volume is unknown.", +"The volume is being created.", +"The volume is hot and bound to a physical share.", +"The volume is warm - volume is unmountable and doesn't count as an active share, but is on hot storage.", +"The volume is cold and released from its physical share." +], +"type": "string" +} +}, +"type": "object" +}, +"VolumePool": { +"description": "VolumePool representation of a Cloud Filestore volume pool.", +"id": "VolumePool", +"properties": { +"activeVolumeCount": { +"description": "Optional. The number of active volumes. Default: 100.", +"format": "int32", +"type": "integer" +}, +"activeVolumeIops": { +"description": "Optional. The number of IOPs provisioned per active volume.", +"format": "int32", +"type": "integer" +}, +"autoFreezeDelay": { +"description": "Optional. How long a volume stays `WARM` after it is deactivated before it is automatically frozen (moved to `COLD`). Must be positive if set. Default: 7 days.", +"format": "google-duration", +"type": "string" +}, +"createTime": { +"description": "Output only. The time when the volume pool was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultVolumeQuotaMib": { +"description": "Optional. The default quota per volume in MiB. Must be between 100 MiB and 102400 MiB (100 GiB). Default: 1024 MiB.", +"format": "int32", +"type": "integer" +}, +"description": { +"description": "Optional. A description of the volume pool with 2048 characters or less.", +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Resource labels to represent user provided metadata.", +"type": "object" +}, +"name": { +"description": "Identifier. The resource name of the volume pool, in the format `projects/{project}/locations/{location}/volumePools/{volume_pool}`.", +"type": "string" +}, +"network": { +"description": "Required. The VPC network to which the VolumePool should be attached. Only Private Service Connect (PSC) is supported.", +"type": "string" +}, +"state": { +"description": "Output only. The state of the volume pool.", +"enum": [ +"STATE_UNSPECIFIED", +"READY", +"DELETING", +"INVALID" +], +"enumDescriptions": [ +"State is not specified.", +"Volume pool is available for use.", +"Volume pool is being deleted.", +"Volume pool is in an invalid state." +], +"readOnly": true, +"type": "string" +}, +"uid": { +"description": "Output only. System-assigned unique identifier for the volume pool.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "WeeklyCycle": { "description": "Time window specified for weekly operations.", "id": "WeeklyCycle", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 8301c0c074..ae41304a98 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20261106", +"revision": "20261108", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -3408,6 +3408,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1FunctionCallingConfig", "description": "Optional. Function calling config." }, +"includeServerSideToolInvocations": { +"description": "Optional. If true, the API response will include the server-side tool calls and responses within the `Content` message. This allows clients to observe the server's tool interactions.", +"type": "boolean" +}, "retrievalConfig": { "$ref": "GoogleCloudAiplatformV1beta1RetrievalConfig", "description": "Optional. Retrieval config." diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 127b1f079b..dc4889e09a 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20261025", +"revision": "20261031", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7492,6 +7492,7 @@ false "MODERNIZATION_INCOMPATIBLE_CONFIG", "MODERNIZATION_INCOMPATIBLE_GATEWAY_POD_SCALE", "MODERNIZATION_REQUIRES_MANUAL_WORKLOAD_RESTART", +"MODERNIZATION_UNEVICTABLE_POD_DISRUPTION_BUDGET", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -7562,6 +7563,7 @@ false "Incompatible config found in the cluster.", "Gateway pods per cluster limit exceeded.", "Cluster contains workloads that will require manual restart during modernization.", +"Cluster contains PodDisruptionBudgets that prevent automated pod eviction during modernization.", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", @@ -7764,6 +7766,7 @@ false "MODERNIZATION_INCOMPATIBLE_CONFIG", "MODERNIZATION_INCOMPATIBLE_GATEWAY_POD_SCALE", "MODERNIZATION_REQUIRES_MANUAL_WORKLOAD_RESTART", +"MODERNIZATION_UNEVICTABLE_POD_DISRUPTION_BUDGET", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -7834,6 +7837,7 @@ false "Incompatible config found in the cluster.", "Gateway pods per cluster limit exceeded.", "Cluster contains workloads that will require manual restart during modernization.", +"Cluster contains PodDisruptionBudgets that prevent automated pod eviction during modernization.", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json index fb004065a7..accda5cfdf 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2beta.json @@ -554,7 +554,7 @@ } } }, -"revision": "20261017", +"revision": "20261031", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceState": { @@ -3161,6 +3161,7 @@ "MODERNIZATION_INCOMPATIBLE_CONFIG", "MODERNIZATION_INCOMPATIBLE_GATEWAY_POD_SCALE", "MODERNIZATION_REQUIRES_MANUAL_WORKLOAD_RESTART", +"MODERNIZATION_UNEVICTABLE_POD_DISRUPTION_BUDGET", "MODERNIZATION_SCHEDULED", "MODERNIZATION_IN_PROGRESS", "MODERNIZATION_COMPLETED", @@ -3231,6 +3232,7 @@ "Incompatible config found in the cluster.", "Gateway pods per cluster limit exceeded.", "Cluster contains workloads that will require manual restart during modernization.", +"Cluster contains PodDisruptionBudgets that prevent automated pod eviction during modernization.", "Modernization is scheduled for a cluster.", "Modernization is in progress for a cluster.", "Modernization is completed for a cluster.", diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index 84b2dffea5..e23b911563 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -20,12 +20,39 @@ "https://www.googleapis.com/auth/gmail.compose": { "description": "Manage drafts and send emails" }, +"https://www.googleapis.com/auth/gmail.drafts": { +"description": "Read, compose, send, update, and permanently delete your draft emails" +}, +"https://www.googleapis.com/auth/gmail.drafts.create": { +"description": "Compose new draft emails" +}, +"https://www.googleapis.com/auth/gmail.drafts.readonly": { +"description": "Read your draft emails" +}, "https://www.googleapis.com/auth/gmail.insert": { "description": "Add emails into your Gmail mailbox" }, "https://www.googleapis.com/auth/gmail.labels": { "description": "See and edit your email labels" }, +"https://www.googleapis.com/auth/gmail.labels.create": { +"description": "Create new email labels" +}, +"https://www.googleapis.com/auth/gmail.labels.readonly": { +"description": "Read your email labels" +}, +"https://www.googleapis.com/auth/gmail.messages": { +"description": "Read, update, and permanently delete all your emails" +}, +"https://www.googleapis.com/auth/gmail.messages.delete": { +"description": "Permanently delete all your emails" +}, +"https://www.googleapis.com/auth/gmail.messages.modify": { +"description": "Update but not delete your emails" +}, +"https://www.googleapis.com/auth/gmail.messages.readonly": { +"description": "Read your emails" +}, "https://www.googleapis.com/auth/gmail.metadata": { "description": "View your email message metadata such as labels and headers, but not the email body" }, @@ -38,9 +65,18 @@ "https://www.googleapis.com/auth/gmail.send": { "description": "Send email on your behalf" }, +"https://www.googleapis.com/auth/gmail.send.self": { +"description": "Send email to yourself" +}, "https://www.googleapis.com/auth/gmail.settings.basic": { "description": "See, edit, create, or change your email settings and filters in Gmail" }, +"https://www.googleapis.com/auth/gmail.settings.filters": { +"description": "Read, create, and delete your filters" +}, +"https://www.googleapis.com/auth/gmail.settings.filters.readonly": { +"description": "Read your filters" +}, "https://www.googleapis.com/auth/gmail.settings.sharing": { "description": "Manage your sensitive mail settings, including who can manage your mail" } @@ -278,6 +314,8 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", +"https://www.googleapis.com/auth/gmail.drafts", +"https://www.googleapis.com/auth/gmail.drafts.create", "https://www.googleapis.com/auth/gmail.modify" ], "supportsMediaUpload": true @@ -311,6 +349,7 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", +"https://www.googleapis.com/auth/gmail.drafts", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -363,6 +402,8 @@ "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.compose", +"https://www.googleapis.com/auth/gmail.drafts", +"https://www.googleapis.com/auth/gmail.drafts.readonly", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" ] @@ -414,6 +455,8 @@ "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.compose", +"https://www.googleapis.com/auth/gmail.drafts", +"https://www.googleapis.com/auth/gmail.drafts.readonly", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" ] @@ -517,6 +560,7 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", +"https://www.googleapis.com/auth/gmail.drafts", "https://www.googleapis.com/auth/gmail.modify" ], "supportsMediaUpload": true @@ -589,6 +633,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -625,6 +671,7 @@ "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.labels", +"https://www.googleapis.com/auth/gmail.labels.create", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -690,6 +737,7 @@ "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.labels", +"https://www.googleapis.com/auth/gmail.labels.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -719,6 +767,7 @@ "scopes": [ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.labels", +"https://www.googleapis.com/auth/gmail.labels.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -824,7 +873,9 @@ "$ref": "BatchDeleteMessagesRequest" }, "scopes": [ -"https://mail.google.com/" +"https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete" ] }, "batchModify": { @@ -850,6 +901,9 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", +"https://www.googleapis.com/auth/gmail.messages.modify", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -879,7 +933,9 @@ }, "path": "gmail/v1/users/{userId}/messages/{id}", "scopes": [ -"https://mail.google.com/" +"https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete" ] }, "get": { @@ -939,6 +995,8 @@ "https://www.googleapis.com/auth/gmail.addons.current.message.action", "https://www.googleapis.com/auth/gmail.addons.current.message.metadata", "https://www.googleapis.com/auth/gmail.addons.current.message.readonly", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -1142,6 +1200,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -1180,6 +1240,9 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", +"https://www.googleapis.com/auth/gmail.messages.modify", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -1228,7 +1291,8 @@ "https://www.googleapis.com/auth/gmail.addons.current.action.compose", "https://www.googleapis.com/auth/gmail.compose", "https://www.googleapis.com/auth/gmail.modify", -"https://www.googleapis.com/auth/gmail.send" +"https://www.googleapis.com/auth/gmail.send", +"https://www.googleapis.com/auth/gmail.send.self" ], "supportsMediaUpload": true }, @@ -1262,6 +1326,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -1295,6 +1361,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", "https://www.googleapis.com/auth/gmail.modify" ] } @@ -1341,6 +1409,8 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.addons.current.message.action", "https://www.googleapis.com/auth/gmail.addons.current.message.readonly", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" ] @@ -2193,7 +2263,8 @@ "$ref": "Filter" }, "scopes": [ -"https://www.googleapis.com/auth/gmail.settings.basic" +"https://www.googleapis.com/auth/gmail.settings.basic", +"https://www.googleapis.com/auth/gmail.settings.filters" ] }, "delete": { @@ -2222,7 +2293,8 @@ }, "path": "gmail/v1/users/{userId}/settings/filters/{id}", "scopes": [ -"https://www.googleapis.com/auth/gmail.settings.basic" +"https://www.googleapis.com/auth/gmail.settings.basic", +"https://www.googleapis.com/auth/gmail.settings.filters" ] }, "get": { @@ -2257,7 +2329,9 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly", -"https://www.googleapis.com/auth/gmail.settings.basic" +"https://www.googleapis.com/auth/gmail.settings.basic", +"https://www.googleapis.com/auth/gmail.settings.filters", +"https://www.googleapis.com/auth/gmail.settings.filters.readonly" ] }, "list": { @@ -2285,7 +2359,9 @@ "https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly", -"https://www.googleapis.com/auth/gmail.settings.basic" +"https://www.googleapis.com/auth/gmail.settings.basic", +"https://www.googleapis.com/auth/gmail.settings.filters", +"https://www.googleapis.com/auth/gmail.settings.filters.readonly" ] } } @@ -2864,7 +2940,9 @@ }, "path": "gmail/v1/users/{userId}/threads/{id}", "scopes": [ -"https://mail.google.com/" +"https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete" ] }, "get": { @@ -2922,6 +3000,8 @@ "https://www.googleapis.com/auth/gmail.addons.current.message.action", "https://www.googleapis.com/auth/gmail.addons.current.message.metadata", "https://www.googleapis.com/auth/gmail.addons.current.message.readonly", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -2979,6 +3059,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.readonly", "https://www.googleapis.com/auth/gmail.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly" @@ -3017,6 +3099,9 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", +"https://www.googleapis.com/auth/gmail.messages.modify", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -3050,6 +3135,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", "https://www.googleapis.com/auth/gmail.modify" ] }, @@ -3083,6 +3170,8 @@ }, "scopes": [ "https://mail.google.com/", +"https://www.googleapis.com/auth/gmail.messages", +"https://www.googleapis.com/auth/gmail.messages.delete", "https://www.googleapis.com/auth/gmail.modify" ] } @@ -3091,7 +3180,7 @@ } } }, -"revision": "20261005", +"revision": "20261106", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index 7ddc9eacbf..1bcd5132fe 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -1159,7 +1159,7 @@ } } }, -"revision": "20261030", +"revision": "20261111", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -4789,7 +4789,8 @@ "LUTEINIZING_HORMONE_SURGE", "ESTROGEN_SURGE", "POSITIVE", -"INDETERMINATE" +"INDETERMINATE", +"OWN_METHOD" ], "enumDescriptions": [ "Unspecified result.", @@ -4797,13 +4798,30 @@ "Luteinizing hormone surge.", "Estrogen surge.", "Positive result.", -"Indeterminate result." +"Indeterminate result.", +"Ovulation day the user identified by their own method, not a test kit." ], "type": "string" }, "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which ovulation test was measured." +}, +"testType": { +"description": "Optional. The type of ovulation test.", +"enum": [ +"TEST_TYPE_UNSPECIFIED", +"STRIP", +"DIGITAL", +"OWN_METHOD" +], +"enumDescriptions": [ +"Unspecified test type.", +"Test strip.", +"Digital test.", +"The user's own method, not a test kit." +], +"type": "string" } }, "type": "object" @@ -6207,7 +6225,10 @@ "SWELLING", "VAGINAL_DRYNESS", "VAGINAL_ITCHING", -"VOMITING" +"VOMITING", +"LIMBS_SWELLING", +"FACE_SWELLING", +"NASAL_CONGESTION" ], "enumDescriptions": [ "Unspecified symptom value.", @@ -6275,7 +6296,10 @@ "Swelling.", "Vaginal dryness.", "Vaginal itching.", -"Vomiting." +"Vomiting.", +"Swelling of the arms or legs.", +"Swelling of the face.", +"Nasal congestion." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/health.v4beta.json b/googleapiclient/discovery_cache/documents/health.v4beta.json index a5c602b9b5..db5a3859b9 100644 --- a/googleapiclient/discovery_cache/documents/health.v4beta.json +++ b/googleapiclient/discovery_cache/documents/health.v4beta.json @@ -1159,7 +1159,7 @@ } } }, -"revision": "20261030", +"revision": "20261111", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -4793,7 +4793,8 @@ "LUTEINIZING_HORMONE_SURGE", "ESTROGEN_SURGE", "POSITIVE", -"INDETERMINATE" +"INDETERMINATE", +"OWN_METHOD" ], "enumDescriptions": [ "Unspecified result.", @@ -4801,13 +4802,30 @@ "Luteinizing hormone surge.", "Estrogen surge.", "Positive result.", -"Indeterminate result." +"Indeterminate result.", +"Ovulation day the user identified by their own method, not a test kit." ], "type": "string" }, "sampleTime": { "$ref": "ObservationSampleTime", "description": "Required. The time at which ovulation test was measured." +}, +"testType": { +"description": "Optional. The type of ovulation test.", +"enum": [ +"TEST_TYPE_UNSPECIFIED", +"STRIP", +"DIGITAL", +"OWN_METHOD" +], +"enumDescriptions": [ +"Unspecified test type.", +"Test strip.", +"Digital test.", +"The user's own method, not a test kit." +], +"type": "string" } }, "type": "object" @@ -6304,7 +6322,10 @@ "SWELLING", "VAGINAL_DRYNESS", "VAGINAL_ITCHING", -"VOMITING" +"VOMITING", +"LIMBS_SWELLING", +"FACE_SWELLING", +"NASAL_CONGESTION" ], "enumDescriptions": [ "Unspecified symptom value.", @@ -6372,7 +6393,10 @@ "Swelling.", "Vaginal dryness.", "Vaginal itching.", -"Vomiting." +"Vomiting.", +"Swelling of the arms or legs.", +"Swelling of the face.", +"Nasal congestion." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 6d7a30ca0d..86c30f52ec 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -864,7 +864,7 @@ "scimTenants": { "methods": { "create": { -"description": "Gemini Enterprise only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.", +"description": "Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimTenant in a WorkforcePoolProvider. You cannot reuse the name of a deleted SCIM tenant until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.create", @@ -873,14 +873,14 @@ ], "parameters": { "parent": { -"description": "Required. Gemini Enterprise only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", +"description": "Required. Gemini Enterprise and Looker only. The parent to create SCIM tenant. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTenantId": { -"description": "Required. Gemini Enterprise only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters `[a-z0-9-]`.", +"description": "Required. Gemini Enterprise and Looker only. The ID to use for the SCIM tenant, which becomes the final component of the resource name. This value should be 4-32 characters, containing the characters `[a-z0-9-]`.", "location": "query", "type": "string" } @@ -897,7 +897,7 @@ ] }, "delete": { -"description": "Gemini Enterprise only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.", +"description": "Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimTenant. You can undelete a SCIM tenant for 30 days. After 30 days, deletion is permanent. You cannot update deleted SCIM tenants. However, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.delete", @@ -911,7 +911,7 @@ "type": "boolean" }, "name": { -"description": "Required. Gemini Enterprise only. The name of the SCIM tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -927,7 +927,7 @@ ] }, "get": { -"description": "Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimTenant.", +"description": "Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.get", @@ -936,7 +936,7 @@ ], "parameters": { "name": { -"description": "Required. Gemini Enterprise only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -980,7 +980,7 @@ ] }, "list": { -"description": "Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.", +"description": "Gemini Enterprise and Looker only. Lists all non-deleted WorkforcePoolProviderScimTenants in a WorkforcePoolProvider. If `show_deleted` is set to `true`, then deleted SCIM tenants are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.list", @@ -989,25 +989,25 @@ ], "parameters": { "pageSize": { -"description": "Optional. Gemini Enterprise only. The maximum number of SCIM tenants to return. If unspecified, at most 50 SCIM tenants will be returned. The maximum value is 100; values above 100 are truncated to 100.", +"description": "Optional. Gemini Enterprise and Looker only. The maximum number of SCIM tenants to return. If unspecified, at most 50 SCIM tenants will be returned. The maximum value is 100; values above 100 are truncated to 100.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Gemini Enterprise only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", +"description": "Optional. Gemini Enterprise and Looker only. A page token, received from a previous `ListScimTenants` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Gemini Enterprise only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", +"description": "Required. Gemini Enterprise and Looker only. The parent to list SCIM tenants. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+$", "required": true, "type": "string" }, "showDeleted": { -"description": "Optional. Gemini Enterprise only. Whether to return soft-deleted SCIM tenants.", +"description": "Optional. Gemini Enterprise and Looker only. Whether to return soft-deleted SCIM tenants.", "location": "query", "type": "boolean" } @@ -1021,7 +1021,7 @@ ] }, "patch": { -"description": "Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimTenant.", +"description": "Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimTenant.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.patch", @@ -1030,14 +1030,14 @@ ], "parameters": { "name": { -"description": "Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", +"description": "Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. Gemini Enterprise only. The list of fields to update.", +"description": "Optional. Gemini Enterprise and Looker only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1111,7 +1111,7 @@ ] }, "undelete": { -"description": "Gemini Enterprise only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.", +"description": "Gemini Enterprise and Looker only. Undeletes a WorkforcePoolProviderScimTenant, that was deleted fewer than 30 days ago.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}:undelete", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.undelete", @@ -1120,7 +1120,7 @@ ], "parameters": { "name": { -"description": "Required. Gemini Enterprise only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", +"description": "Required. Gemini Enterprise and Looker only. The name of the SCIM tenant to undelete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, @@ -1143,7 +1143,7 @@ "tokens": { "methods": { "create": { -"description": "Gemini Enterprise only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", +"description": "Gemini Enterprise and Looker only. Creates a new WorkforcePoolProviderScimToken in a WorkforcePoolProviderScimTenant. You cannot reuse the name of a deleted SCIM token until 30 days after deletion.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "POST", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.create", @@ -1152,14 +1152,14 @@ ], "parameters": { "parent": { -"description": "Required. Gemini Enterprise only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", +"description": "Required. Gemini Enterprise and Looker only. The parent tenant to create SCIM token. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "workforcePoolProviderScimTokenId": { -"description": "Required. Gemini Enterprise only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: `([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))`", +"description": "Required. Gemini Enterprise and Looker only. The ID to use for the SCIM token, which becomes the final component of the resource name. This value should be 4-32 characters and follow the pattern: `([a-z]([a-z0-9\\\\-]{2,30}[a-z0-9]))`", "location": "query", "type": "string" } @@ -1176,7 +1176,7 @@ ] }, "delete": { -"description": "Gemini Enterprise only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.", +"description": "Gemini Enterprise and Looker only. Deletes a WorkforcePoolProviderScimToken. You can undelete a SCIM token for 30 days. After 30 days, the SCIM token is permanently deleted. You cannot update deleted SCIM tokens, however, you can view and list them.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "DELETE", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.delete", @@ -1185,7 +1185,7 @@ ], "parameters": { "name": { -"description": "Required. Gemini Enterprise only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Required. Gemini Enterprise and Looker only. The name of the SCIM token to delete. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1201,7 +1201,7 @@ ] }, "get": { -"description": "Gemini Enterprise only. Gets an individual WorkforcePoolProviderScimToken.", +"description": "Gemini Enterprise and Looker only. Gets an individual WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.get", @@ -1210,7 +1210,7 @@ ], "parameters": { "name": { -"description": "Required. Gemini Enterprise only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Required. Gemini Enterprise and Looker only. The name of the SCIM token to retrieve. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, @@ -1226,7 +1226,7 @@ ] }, "list": { -"description": "Gemini Enterprise only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", +"description": "Gemini Enterprise and Looker only. Lists all non-deleted WorkforcePoolProviderScimTokenss in a WorkforcePoolProviderScimTenant. If `show_deleted` is set to `true`, then deleted SCIM tokens are also listed.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens", "httpMethod": "GET", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.list", @@ -1235,25 +1235,25 @@ ], "parameters": { "pageSize": { -"description": "Optional. Gemini Enterprise only. The maximum number of SCIM tokens to return. If unspecified, at most 2 SCIM tokens will be returned.", +"description": "Optional. Gemini Enterprise and Looker only. The maximum number of SCIM tokens to return. If unspecified, at most 2 SCIM tokens will be returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. Gemini Enterprise only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", +"description": "Optional. Gemini Enterprise and Looker only. A page token, received from a previous `ListWorkforcePoolProviderScimTokens` call. Provide this to retrieve the subsequent page.", "location": "query", "type": "string" }, "parent": { -"description": "Required. Gemini Enterprise only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", +"description": "Required. Gemini Enterprise and Looker only. The parent to list SCIM tokens. Format: 'locations/{location}/workforcePools/{workforce_pool}/providers/{provider}/scimTenants/{scim_tenant}'", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+$", "required": true, "type": "string" }, "showDeleted": { -"description": "Optional. Gemini Enterprise only. Whether to return soft-deleted SCIM tokens.", +"description": "Optional. Gemini Enterprise and Looker only. Whether to return soft-deleted SCIM tokens.", "location": "query", "type": "boolean" } @@ -1267,7 +1267,7 @@ ] }, "patch": { -"description": "Gemini Enterprise only. Updates an existing WorkforcePoolProviderScimToken.", +"description": "Gemini Enterprise and Looker only. Updates an existing WorkforcePoolProviderScimToken.", "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/providers/{providersId}/scimTenants/{scimTenantsId}/tokens/{tokensId}", "httpMethod": "PATCH", "id": "iam.locations.workforcePools.providers.scimTenants.tokens.patch", @@ -1276,14 +1276,14 @@ ], "parameters": { "name": { -"description": "Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "location": "path", "pattern": "^locations/[^/]+/workforcePools/[^/]+/providers/[^/]+/scimTenants/[^/]+/tokens/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Optional. Gemini Enterprise only. The list of fields to update.", +"description": "Optional. Gemini Enterprise and Looker only. The list of fields to update.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -4369,7 +4369,7 @@ } } }, -"revision": "20261023", +"revision": "20261106", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -5212,15 +5212,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTenantsResponse": { -"description": "Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTenants.", +"description": "Gemini Enterprise and Looker only. Response message for ListWorkforcePoolProviderScimTenants.", "id": "ListWorkforcePoolProviderScimTenantsResponse", "properties": { "nextPageToken": { -"description": "Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"description": "Optional. Gemini Enterprise and Looker only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTenants": { -"description": "Output only. Gemini Enterprise only. A list of SCIM tenants.", +"description": "Output only. Gemini Enterprise and Looker only. A list of SCIM tenants.", "items": { "$ref": "WorkforcePoolProviderScimTenant" }, @@ -5231,15 +5231,15 @@ "type": "object" }, "ListWorkforcePoolProviderScimTokensResponse": { -"description": "Gemini Enterprise only. Response message for ListWorkforcePoolProviderScimTokens.", +"description": "Gemini Enterprise and Looker only. Response message for ListWorkforcePoolProviderScimTokens.", "id": "ListWorkforcePoolProviderScimTokensResponse", "properties": { "nextPageToken": { -"description": "Optional. Gemini Enterprise only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"description": "Optional. Gemini Enterprise and Looker only. A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "workforcePoolProviderScimTokens": { -"description": "Output only. Gemini Enterprise only. A list of SCIM tokens.", +"description": "Output only. Gemini Enterprise and Looker only. A list of SCIM tokens.", "items": { "$ref": "WorkforcePoolProviderScimToken" }, @@ -6381,7 +6381,7 @@ false "type": "object" }, "UndeleteWorkforcePoolProviderScimTenantRequest": { -"description": "Gemini Enterprise only. Request message for UndeleteWorkforcePoolProviderScimTenant.", +"description": "Gemini Enterprise and Looker only. Request message for UndeleteWorkforcePoolProviderScimTenant.", "id": "UndeleteWorkforcePoolProviderScimTenantRequest", "properties": {}, "type": "object" @@ -6512,6 +6512,11 @@ false "description": "Required. Maps attributes from the authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.groups`: Groups the authenticating user belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. * `google.display_name`: The name of the authenticated user. This is an optional field and the mapped display name cannot exceed 100 bytes. If not set, `google.subject` will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.profile_photo`: The URL that specifies the authenticated user's thumbnail photo. This is an optional field. When set, the image will be visible as the user's profile picture. If not set, a generic user icon will be displayed instead. This attribute cannot be referenced in IAM bindings. * `google.posix_username`: The Linux username used by OS Login. This is an optional field and the mapped POSIX username cannot exceed 32 characters. The key must match the regex `^a-zA-Z0-9._{0,31}$`. This attribute cannot be referenced in IAM bindings. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where {custom_attribute} is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters `[a-z0-9_]`. You can reference these attributes in IAM policies to define fine-grained access for a workforce pool to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/locations/global/workforcePools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 16 KB. For OIDC providers, you must supply a custom mapping that includes the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {\"google.subject\": \"assertion.sub\"} ```", "type": "object" }, +"attributeSyncInterval": { +"description": "Optional. An interval that determines how often user attributes are synced from the IdP. Must be between 30 minutes (1800s) and 12 hours (43200s). This configuration is used only when the Google Cloud session length policy is configured. When Google Cloud session length policy is configured and `attribute_sync_interval` is not configured, attributes are synced after a default interval of 12 hours (43200 seconds).", +"format": "google-duration", +"type": "string" +}, "description": { "description": "Optional. A description of the provider. Cannot exceed 256 characters.", "type": "string" @@ -6555,7 +6560,7 @@ false "description": "A SAML identity provider configuration." }, "scimUsage": { -"description": "Optional. Gemini Enterprise only. Specifies whether the workforce identity pool provider uses SCIM-managed groups instead of the `google.groups` attribute mapping for authorization checks. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error.", +"description": "Optional. Gemini Enterprise and Looker only. Specifies whether the workforce identity pool provider uses SCIM-managed groups, or users and groups. The `scim_usage` and `extended_attributes_oauth2_client` fields are mutually exclusive. A request that enables both fields on the same workforce identity pool provider will produce an error.", "enum": [ "SCIM_USAGE_UNSPECIFIED", "ENABLED_FOR_GROUPS", @@ -6564,7 +6569,7 @@ false "enumDescriptions": [ "Indicates that SCIM data is not used.", "Gemini Enterprise only. SCIM sync is enabled and SCIM-managed groups are used for authorization checks.", -"Looker only. SCIM sync is enabled, and SCIM-managed user claims and groups are used for authorization checks." +"Gemini Enterprise and Looker only. SCIM sync is enabled, and SCIM-managed user claims and groups are used for authorization checks." ], "type": "string" }, @@ -6663,11 +6668,11 @@ false "type": "object" }, "WorkforcePoolProviderScimTenant": { -"description": "Gemini Enterprise only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", +"description": "Gemini Enterprise and Looker only. Represents a SCIM tenant. Used for provisioning and managing identity data (such as Users and Groups) in cross-domain environments.", "id": "WorkforcePoolProviderScimTenant", "properties": { "baseUri": { -"description": "Output only. Gemini Enterprise only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", +"description": "Output only. Gemini Enterprise and Looker only. Represents the base URI as defined in [RFC 7644, Section 1.3](https://datatracker.ietf.org/doc/html/rfc7644#section-1.3). Clients must use this as the root address for managing resources under the tenant. Format: https://iamscim.googleapis.com/{version}/{tenant_id}/", "readOnly": true, "type": "string" }, @@ -6675,23 +6680,23 @@ false "additionalProperties": { "type": "string" }, -"description": "Required. Immutable. Gemini Enterprise only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { \"google.subject\": \"user.externalId\", \"google.group\": \"group.externalId\" } ```", +"description": "Required. Immutable. Gemini Enterprise and Looker only. Maps SCIM attributes to Google attributes. This mapping is used to associate the attributes synced via SCIM with the Google Cloud attributes used in IAM policies for Workforce Identity Federation. SCIM-managed user and group attributes are mapped to `google.subject` and `google.group` respectively. Each key must be a string specifying the Google Cloud IAM attribute to map to. The supported keys are as follows: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. This is a required field and the mapped subject cannot exceed 127 bytes. * `google.group`: Group the authenticating user belongs to. You can grant group access to resources using an IAM `principalSet` binding; access applies to all members of the group. Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) expression that maps SCIM user or group attribute to the normalized attribute specified by the corresponding map key. Example: To map the SCIM user's `externalId` to `google.subject` and the SCIM group's `externalId` to `google.group`: ``` { \"google.subject\": \"user.externalId\", \"google.group\": \"group.externalId\" } ```", "type": "object" }, "description": { -"description": "Optional. Gemini Enterprise only. The description of the SCIM tenant. Cannot exceed 256 characters.", +"description": "Optional. Gemini Enterprise and Looker only. The description of the SCIM tenant. Cannot exceed 256 characters.", "type": "string" }, "displayName": { -"description": "Optional. Gemini Enterprise only. The display name of the SCIM tenant. Cannot exceed 32 characters.", +"description": "Optional. Gemini Enterprise and Looker only. The display name of the SCIM tenant. Cannot exceed 32 characters.", "type": "string" }, "name": { -"description": "Identifier. Gemini Enterprise only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", +"description": "Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Tenant. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}`", "type": "string" }, "purgeTime": { -"description": "Output only. Gemini Enterprise only. The timestamp that represents the time when the SCIM tenant is purged.", +"description": "Output only. Gemini Enterprise and Looker only. The timestamp that represents the time when the SCIM tenant is purged.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -6702,16 +6707,16 @@ false "type": "string" }, "state": { -"description": "Output only. Gemini Enterprise only. The state of the tenant.", +"description": "Output only. Gemini Enterprise and Looker only. The state of the tenant.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ -"Gemini Enterprise only. State unspecified.", -"Gemini Enterprise only. The tenant is active and may be used to provision users and groups.", -"Gemini Enterprise only. The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." +"Gemini Enterprise and Looker only. State unspecified.", +"Gemini Enterprise and Looker only. The tenant is active and may be used to provision users and groups.", +"Gemini Enterprise and Looker only. The tenant is soft-deleted. Soft-deleted tenants are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" @@ -6720,33 +6725,33 @@ false "type": "object" }, "WorkforcePoolProviderScimToken": { -"description": "Gemini Enterprise only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.", +"description": "Gemini Enterprise and Looker only. Represents a token for the WorkforcePoolProviderScimTenant. Used for authenticating SCIM provisioning requests.", "id": "WorkforcePoolProviderScimToken", "properties": { "displayName": { -"description": "Optional. Gemini Enterprise only. The display name of the SCIM token. Cannot exceed 32 characters.", +"description": "Optional. Gemini Enterprise and Looker only. The display name of the SCIM token. Cannot exceed 32 characters.", "type": "string" }, "name": { -"description": "Identifier. Gemini Enterprise only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", +"description": "Identifier. Gemini Enterprise and Looker only. The resource name of the SCIM Token. Format: `locations/{location}/workforcePools/{workforce_pool}/providers/ {workforce_pool_provider}/scimTenants/{scim_tenant}/tokens/{token}`", "type": "string" }, "securityToken": { -"description": "Output only. Gemini Enterprise only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", +"description": "Output only. Gemini Enterprise and Looker only. The token string. Provide this to the IdP for authentication. Will be set only during creation.", "readOnly": true, "type": "string" }, "state": { -"description": "Output only. Gemini Enterprise only. The state of the token.", +"description": "Output only. Gemini Enterprise and Looker only. The state of the token.", "enum": [ "STATE_UNSPECIFIED", "ACTIVE", "DELETED" ], "enumDescriptions": [ -"Gemini Enterprise only. State unspecified.", -"Gemini Enterprise only. The token is active and may be used to provision users and groups.", -"Gemini Enterprise only. The token is soft-deleted. Soft-deleted tokens are permanently deleted after approximately 30 days." +"Gemini Enterprise and Looker only. State unspecified.", +"Gemini Enterprise and Looker only. The token is active and may be used to provision users and groups.", +"Gemini Enterprise and Looker only. The token is soft-deleted. Soft-deleted tokens are permanently deleted after approximately 30 days." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index aaab0d8855..152e4cbe21 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -15,6 +15,233 @@ "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iap", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -682,7 +909,7 @@ } } }, -"revision": "20260428", +"revision": "20261106", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1beta1.json b/googleapiclient/discovery_cache/documents/iap.v1beta1.json index 44cd435ad6..09f529bcc7 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -15,6 +15,233 @@ "description": "Controls access to cloud applications running on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/iap", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.africa-south1.rep.googleapis.com/", +"location": "africa-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.asia-southeast3.rep.googleapis.com/", +"location": "asia-southeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.australia-southeast1.rep.googleapis.com/", +"location": "australia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west15.rep.googleapis.com/", +"location": "europe-west15" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.europe-west9.rep.googleapis.com/", +"location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://iap.us-west8.rep.googleapis.com/", +"location": "us-west8" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -194,7 +421,7 @@ } } }, -"revision": "20240701", +"revision": "20261106", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/looker.v1.json b/googleapiclient/discovery_cache/documents/looker.v1.json index cdd53c1e39..920da435c6 100644 --- a/googleapiclient/discovery_cache/documents/looker.v1.json +++ b/googleapiclient/discovery_cache/documents/looker.v1.json @@ -18,6 +18,16 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://looker.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://looker.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://looker.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -800,7 +810,7 @@ } } }, -"revision": "20261020", +"revision": "20261108", "rootUrl": "https://looker.googleapis.com/", "schemas": { "AdminSettings": { @@ -842,24 +852,6 @@ "description": "ComponentMetrics contains sizing, timing, retries, and metrics for an exported component.", "id": "ComponentMetrics", "properties": { -"componentType": { -"description": "Type of the exported component.", -"enum": [ -"TYPE_UNSPECIFIED", -"BQ_ESA", -"DB", -"FS", -"ALL" -], -"enumDescriptions": [ -"Unspecified component type.", -"BigQuery Elite System Activity component.", -"Database component.", -"File system component.", -"Overall Export Job." -], -"type": "string" -}, "duration": { "description": "Duration of the component export.", "format": "google-duration", @@ -884,6 +876,24 @@ "description": "Start timestamp of the component export.", "format": "google-datetime", "type": "string" +}, +"type": { +"description": "Type of the exported component.", +"enum": [ +"TYPE_UNSPECIFIED", +"BQ_ESA", +"DB", +"FS", +"ALL" +], +"enumDescriptions": [ +"Unspecified component type.", +"BigQuery Elite System Activity component.", +"Database component.", +"File system component.", +"Overall Export Job." +], +"type": "string" } }, "type": "object" @@ -1057,7 +1067,7 @@ "id": "ExportMetadata", "properties": { "esaMigrationToken": { -"description": "Opaque capability token for O2C Elite System Activity (ESA) direct dataset migration. It is minted by the exporter together with the cloned source dataset and presented back to Looker Original when the import requests access to that dataset.", +"description": "Opaque capability token for O2C Elite System Activity (ESA) direct dataset migration, encrypted by the exporter with the export encryption key (base64-encoded Cloud KMS ciphertext). It is minted by the exporter together with the cloned source dataset; Looker Core CLH decrypts it with the import's service account and presents the plaintext to Looker Original when the import requests access to that dataset.", "type": "string" }, "esaSourceDatasetId": { diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index 0c6a2fa72c..e6c0b134d8 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -416,7 +416,7 @@ } } }, -"revision": "20250815", +"revision": "20261112", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -465,6 +465,13 @@ "description": "The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure.", "type": "string" }, +"documentLink": { +"description": "Optional. URLs of PDF documents for the product, such as user manuals or specifications.", +"items": { +"type": "string" +}, +"type": "array" +}, "excludedDestination": { "description": "A list of excluded destinations such as \"ClientExport\", \"ClientShoppingCatalog\" or \"PartnerShoppingCatalog\". For more information, see https://support.google.com/manufacturers/answer/7443550", "items": { @@ -524,6 +531,10 @@ "description": "The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.", "type": "string" }, +"itemGroupTitle": { +"description": "Optional. The shared title of the product group that this variant belongs to.", +"type": "string" +}, "material": { "description": "The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material.", "type": "string" @@ -540,6 +551,11 @@ "description": "The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern.", "type": "string" }, +"popularityRank": { +"description": "Optional. The popularity rank of the product from 0.0 (lowest) to 100.0 (highest).", +"format": "double", +"type": "number" +}, "productDetail": { "description": "The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.", "items": { @@ -573,6 +589,20 @@ }, "type": "array" }, +"questionAndAnswer": { +"description": "Optional. Frequently asked questions and answers about the product.", +"items": { +"$ref": "QuestionAndAnswer" +}, +"type": "array" +}, +"relatedProduct": { +"description": "Optional. Products related to this product, such as accessories or substitutes.", +"items": { +"$ref": "RelatedProduct" +}, +"type": "array" +}, "releaseDate": { "description": "The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release.", "type": "string" @@ -619,6 +649,13 @@ "description": "The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title.", "type": "string" }, +"variantOption": { +"description": "Optional. The list of all variant-identifying options for the product.", +"items": { +"$ref": "VariantOption" +}, +"type": "array" +}, "videoLink": { "description": "The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video.", "items": { @@ -661,6 +698,14 @@ "description": "Optional. A unique code to identify the certification.", "type": "string" }, +"documentLink": { +"description": "Optional. A URL to the certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf In case of multiple languages, the English version is preferred.", +"type": "string" +}, +"labelLink": { +"description": "Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf", +"type": "string" +}, "link": { "description": "Optional. A URL link to the certification.", "type": "string" @@ -804,6 +849,14 @@ "description": "Optional. A unique code to identify the certification.", "type": "string" }, +"documentLink": { +"description": "Optional. A URL to the (English if >1 language) certification fiche. For example: https://eprel.ec.europa.eu/fiches/smartphonestablets20231669/Fiche_2556297_EN.pdf", +"type": "string" +}, +"labelLink": { +"description": "Optional. A URL to the certification label. For example: https://eprel.ec.europa.eu/labels/smartphonestablets20231669/Label_2556297.pdf", +"type": "string" +}, "link": { "description": "Optional. A URL link to the certification.", "type": "string" @@ -1390,6 +1443,55 @@ }, "type": "object" }, +"QuestionAndAnswer": { +"description": "A question and answer about the product.", +"id": "QuestionAndAnswer", +"properties": { +"answer": { +"description": "Required. The answer text.", +"type": "string" +}, +"question": { +"description": "Required. The question text.", +"type": "string" +} +}, +"type": "object" +}, +"RelatedProduct": { +"description": "A product related to this product.", +"id": "RelatedProduct", +"properties": { +"identifier": { +"description": "Required. The identifier of the related product.", +"type": "string" +}, +"identifierType": { +"description": "Required. The identifier type of the related product, such as \"GTIN\" or \"ID\".", +"type": "string" +}, +"relationshipType": { +"description": "Required. The relationship to the related product, such as \"ACCESSORY\", \"PART_OF_SET\", \"REQUIRED_PART\", \"OFTEN_BOUGHT_WITH\", \"SUBSTITUTE\", or \"DIFFERENT_BRAND\".", +"type": "string" +} +}, +"type": "object" +}, +"VariantOption": { +"description": "A variant-identifying option for the product.", +"id": "VariantOption", +"properties": { +"name": { +"description": "Required. The name of the variant option, such as \"Color\" or \"Watch band style\".", +"type": "string" +}, +"value": { +"description": "Required. The value of the variant option, such as \"Red\" or \"Milanese loop\".", +"type": "string" +} +}, +"type": "object" +}, "VoluntaryNutritionFact": { "description": "Voluntary Nutrition Facts.", "id": "VoluntaryNutritionFact", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index 37782c338b..c6c4111560 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -108,7 +108,7 @@ "accounts": { "methods": { "createAndConfigure": { -"description": "Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account.", +"description": "Creates a Merchant Center account with additional configuration. Adds the user that makes the request as an admin for the new account. For step-by-step instructions, see [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts).", "flatPath": "accounts/v1/accounts:createAndConfigure", "httpMethod": "POST", "id": "merchantapi.accounts.createAndConfigure", @@ -126,7 +126,7 @@ ] }, "createTestAccount": { -"description": "Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic.", +"description": "Creates a Merchant Center test account. Test accounts are intended for development and testing purposes, such as validating API integrations or new feature behavior. Key characteristics and limitations of test accounts: - Immutable Type: A test account cannot be converted into a regular (live) Merchant Center account. Likewise, a regular account cannot be converted into a test account. - Non-Serving Products: Any products, offers, or data created within a test account will not be published or made visible to end-users on any Google surfaces. They are strictly for testing environments. - Separate Environment: Test accounts operate in a sandbox-like manner, isolated from live serving and real user traffic. For more information, see [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts).", "flatPath": "accounts/v1/accounts/{accountsId}:createTestAccount", "httpMethod": "POST", "id": "merchantapi.accounts.createTestAccount", @@ -209,7 +209,7 @@ ] }, "list": { -"description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.", +"description": "Note: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case. For more information, see [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter).", "flatPath": "accounts/v1/accounts", "httpMethod": "GET", "id": "merchantapi.accounts.list", @@ -567,7 +567,7 @@ "developerRegistration": { "methods": { "getAccountForGcpRegistration": { -"description": "Retrieves the merchant account that the calling GCP is registered with.", +"description": "Retrieves the merchant account that the calling GCP is registered with. For more information, see [Verify your account's connection to Merchant API](https://developers.google.com/merchant/api/guides/accounts/verify-api-access).", "flatPath": "accounts/v1/accounts:getAccountForGcpRegistration", "httpMethod": "GET", "id": "merchantapi.accounts.developerRegistration.getAccountForGcpRegistration", @@ -607,7 +607,7 @@ ] }, "registerGcp": { -"description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration.", +"description": "Registers the GCP used for the API call to the shopping account passed in the request. Will create a user with an \"API developer\" and add the \"developer_email\" as a contact with \"API notifications\" email preference on. Restrictions: * The caller account must be authenticated and must not impersonate another account at registration time. Registering for subaccounts is not supported if the caller account is authenticated with the parent or the managing advanced account. * The caller account must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center. * [Test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts) are not eligible for registration. For step-by-step instructions, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration).", "flatPath": "accounts/v1/accounts/{accountsId}/developerRegistration:registerGcp", "httpMethod": "POST", "id": "merchantapi.accounts.developerRegistration.registerGcp", @@ -616,7 +616,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts) ) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.", +"description": "Required. The name of the developer registration to be created for the merchant account that the GCP will be registered with. Format: `accounts/{account}/developerRegistration` The {account} used must be the same account where user calling this API method is directly added to. Note: The account used must be a production account (can't be a [test account](https://developers.google.com/merchant/api/guides/accounts/test-accounts)) and must have a [verified website](https://support.google.com/merchants/answer/11586344) in Merchant Center.", "location": "path", "pattern": "^accounts/[^/]+/developerRegistration$", "required": true, @@ -635,7 +635,7 @@ ] }, "unregisterGcp": { -"description": "Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister succussful call.", +"description": "Unregister the calling GCP from the calling shopping account. Note that the GCP will still be able to access the API for at most 1 day from the unregister successful call. For more information, see [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects).", "flatPath": "accounts/v1/accounts/{accountsId}/developerRegistration:unregisterGcp", "httpMethod": "POST", "id": "merchantapi.accounts.developerRegistration.unregisterGcp", @@ -1549,7 +1549,7 @@ "regions": { "methods": { "batchCreate": { -"description": "Creates one or more regions in your Merchant Center account. Executing this method requires admin access.", +"description": "Creates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).", "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchCreate", "httpMethod": "POST", "id": "merchantapi.accounts.regions.batchCreate", @@ -1577,7 +1577,7 @@ ] }, "batchDelete": { -"description": "Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access.", +"description": "Deletes multiple regions by name from your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).", "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchDelete", "httpMethod": "POST", "id": "merchantapi.accounts.regions.batchDelete", @@ -1605,7 +1605,7 @@ ] }, "batchUpdate": { -"description": "Updates one or more regions in your Merchant Center account. Executing this method requires admin access.", +"description": "Updates one or more regions in your Merchant Center account. Executing this method requires admin access. For more information, see [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).", "flatPath": "accounts/v1/accounts/{accountsId}/regions:batchUpdate", "httpMethod": "POST", "id": "merchantapi.accounts.regions.batchUpdate", @@ -2438,7 +2438,7 @@ } } }, -"revision": "20261103", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -2483,7 +2483,7 @@ "type": "object" }, "Accepted": { -"description": "Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/create-and-configure#accept_the_merchant_center_terms_of_service).", +"description": "Describes the [accepted terms of service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements#accept-tos).", "id": "Accepted", "properties": { "acceptedBy": { @@ -2502,7 +2502,7 @@ "type": "object" }, "Account": { -"description": "The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on.", +"description": "The `Account` message represents a business's account within Merchant Center. It's the primary entity for managing product data, settings, and interactions with Google's services and external providers. Accounts can operate as standalone entities or be part of a advanced account structure. In an advanced account setup the parent account manages multiple sub-accounts. Establishing an account involves configuring attributes like the account name, time zone, and language preferences. The `Account` message is the parent entity for many other resources, for example, `AccountRelationship`, `Homepage`, `BusinessInfo` and so on. For more information, see [Sign up for Merchant Center](https://support.google.com/merchants/answer/188924), [Manage accounts and settings](https://developers.google.com/merchant/api/guides/accounts/overview), [Create accounts](https://developers.google.com/merchant/api/guides/accounts/create-accounts), [Create test accounts](https://developers.google.com/merchant/api/guides/accounts/test-accounts), and [Filter accounts you can access](https://developers.google.com/merchant/api/guides/accounts/filter).", "id": "Account", "properties": { "accountId": { @@ -2551,7 +2551,7 @@ "type": "object" }, "AccountIssue": { -"description": "Issues with your Merchant Center account that can impact all your products. For more information, see [Account-level issues in Merchant Center](https://support.google.com/merchants/answer/12153802?sjid=17798438912526418908-EU#account).", +"description": "Issues with your Merchant Center account that can impact all your products. For more information, see [Account-level issues in Merchant Center](https://support.google.com/merchants/answer/12153802#account) and [View account issues](https://developers.google.com/merchant/api/guides/accounts/view-issues).", "id": "AccountIssue", "properties": { "detail": { @@ -2603,7 +2603,7 @@ "type": "object" }, "AccountRelationship": { -"description": "The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce).", +"description": "The `AccountRelationship` message defines a formal connection between a merchant's account and a service provider's account. This relationship enables the provider to offer specific services to the business, such as product management or campaign management. It specifies the access rights and permissions to the business's data relevant to those services. Establishing an account relationship involves linking the merchant's account with a provider's account. The provider could be another Google account (like Google Ads or Google My Business) or a third-party platform (such as Shopify or WooCommerce). For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships).", "id": "AccountRelationship", "properties": { "accountIdAlias": { @@ -2627,7 +2627,7 @@ "type": "object" }, "AccountService": { -"description": "The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API.", +"description": "The `AccountService` message represents a specific service that a provider account offers to a Merchant Center account. `AccountService` defines the permissions and capabilities granted to the provider, allowing for operations such as product management or campaign management. The lifecycle of an `AccountService` involves a proposal phase, where one party suggests the service, and an approval phase, where the other party accepts or rejects it. This handshake mechanism ensures mutual consent before any access is granted. This mechanism safeguards both parties by ensuring that access rights are granted appropriately and that both the business and provider are aware of the services enabled. In scenarios where a user is an admin of both accounts, the approval can happen automatically. The mutability of a service is also managed through `AccountService`. Some services might be immutable, for example, if they were established through other systems or APIs, and you cannot alter them through this API. For more information, see [Account relationships](https://developers.google.com/merchant/api/guides/accounts/relationships) and [Account service changes](https://developers.google.com/merchant/api/guides/notifications/account-service-changes).", "id": "AccountService", "properties": { "accountAggregation": { @@ -2783,7 +2783,7 @@ "type": "object" }, "AutofeedSettings": { -"description": "Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings.", +"description": "Collection of information related to the [autofeed](https://support.google.com/merchants/answer/7538732) settings. For more information, see [Configure Autofeed settings](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources#autofeed-settings).", "id": "AutofeedSettings", "properties": { "eligible": { @@ -2819,7 +2819,7 @@ "type": "object" }, "AutomaticImprovements": { -"description": "Collection of information related to the [automatic improvements](https://developers.google.com/shopping-content/guides/automatic-improvements) of an account.", +"description": "Collection of information related to the [automatic improvements](https://support.google.com/merchants/answer/12157888) of an account. For more information, see [Enable automatic improvements](https://developers.google.com/merchant/api/guides/automatic-improvements/overview).", "id": "AutomaticImprovements", "properties": { "imageImprovements": { @@ -2988,7 +2988,7 @@ "type": "object" }, "BusinessIdentity": { -"description": "Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).", +"description": "Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247). For more information, see [Manage business identity](https://developers.google.com/merchant/api/guides/accounts/business-identity).", "id": "BusinessIdentity", "properties": { "blackOwned": { @@ -3033,7 +3033,7 @@ "type": "object" }, "BusinessInfo": { -"description": "The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers.", +"description": "The `BusinessInfo` message contains essential information about a business. This message captures key business details such as physical address, customer service contacts, and region-specific identifiers. For more information, see [Add your business information](https://support.google.com/merchants/answer/14286818#add_bus_info) and [Update your business information](https://developers.google.com/merchant/api/guides/accounts/create-accounts#update_your_business_information).", "id": "BusinessInfo", "properties": { "address": { @@ -3113,7 +3113,7 @@ "type": "object" }, "CheckoutSettings": { -"description": "[CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant.", +"description": "[CheckoutSettings](https://support.google.com/merchants/answer/13945960) for a specific merchant. For more information, see [Add a checkout link for your products](https://support.google.com/merchants/answer/13945960) and [Manage checkout settings](https://developers.google.com/merchant/api/guides/products/checkout-settings).", "id": "CheckoutSettings", "properties": { "effectiveEnrollmentState": { @@ -3451,7 +3451,7 @@ "type": "object" }, "DeveloperRegistration": { -"description": "Represents a developer registration owned by a Merchant account.", +"description": "Represents a developer registration owned by a Merchant account. For more information, see [Register as a developer](https://developers.google.com/merchant/api/guides/quickstart/registration) and [Manage and transition Google Cloud projects](https://developers.google.com/merchant/api/guides/accounts/manage-transition-gcp-projects).", "id": "DeveloperRegistration", "properties": { "gcpIds": { @@ -3502,7 +3502,7 @@ "type": "object" }, "EmailPreferences": { -"description": "The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.", +"description": "The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them. For more information, see [Change your Merchant Center email preferences](https://support.google.com/merchants/answer/9370919) and [Manage Merchant Center email preferences](https://developers.google.com/merchant/api/guides/accounts/email-notifications).", "id": "EmailPreferences", "properties": { "name": { @@ -3559,7 +3559,7 @@ "type": "object" }, "GbpAccount": { -"description": "Collection of information related to a Google Business Profile (GBP) account.", +"description": "Collection of information related to a Google Business Profile (GBP) account. For more information, see [Link a Google business profile](https://developers.google.com/merchant/api/guides/accounts/link-business-profile).", "id": "GbpAccount", "properties": { "gbpAccountId": { @@ -3706,7 +3706,7 @@ "type": "object" }, "Homepage": { -"description": "The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793).", +"description": "The `Homepage` message represents a business's store homepage within the system. A business's homepage is the primary domain where customers interact with their store. The homepage can be claimed and verified as a proof of ownership and allows the business to unlock features that require a verified website. For more information, see [Understanding online store URL verification](//support.google.com/merchants/answer/176793). For step-by-step instructions, see [Manage homepage settings](https://developers.google.com/merchant/api/guides/accounts/manage-homepage-settings).", "id": "Homepage", "properties": { "claimed": { @@ -4031,7 +4031,7 @@ false "type": "object" }, "LfpProvider": { -"description": "Collection of information related to a Local Feed Partnership (LFP) provider.", +"description": "Collection of information related to a Local Feed Partnership (LFP) provider. For more information, see [Manage Local Feeds Partnership (LFP) providers](https://developers.google.com/merchant/api/guides/accounts/manage-lfp-providers) and [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview).", "id": "LfpProvider", "properties": { "displayName": { @@ -4373,7 +4373,7 @@ false "type": "object" }, "OmnichannelSetting": { -"description": "Collection of information related to the omnichannel settings of a merchant.", +"description": "Collection of information related to the omnichannel settings of a merchant. For more information, see [Manage omnichannel settings](https://developers.google.com/merchant/api/guides/accounts/manage-omnichannel-settings).", "id": "OmnichannelSetting", "properties": { "about": { @@ -4459,7 +4459,7 @@ false "type": "object" }, "OnlineReturnPolicy": { -"description": "[Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs.", +"description": "[Online return policy](https://support.google.com/merchants/answer/10220642) object. This is currently used to represent return policies for ads and free listings programs. For more information, see [Manage your online return policies](https://developers.google.com/merchant/api/guides/online-return-policies/overview).", "id": "OnlineReturnPolicy", "properties": { "acceptDefectiveOnly": { @@ -4850,7 +4850,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -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`](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`", +"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. For more information, see [Manage programs](https://developers.google.com/merchant/api/guides/programs/overview). 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": { @@ -5060,7 +5060,7 @@ false "type": "object" }, "Region": { -"description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region) for more information.", +"description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes, radius areas or, in some countries, using predefined geotargets. A region must be defined by specifying exactly one of `postal_code_area`, `geotarget_area`, or `radius_area`. For more information, see [Set up regions ](https://support.google.com/merchants/answer/7410946#zippy=%2Ccreate-a-new-region), [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions), and [Manage region batching](https://developers.google.com/merchant/api/guides/accounts/manage-region-batching).", "id": "Region", "properties": { "displayName": { @@ -5340,7 +5340,7 @@ false "type": "object" }, "ShippingSettings": { -"description": "The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts.", +"description": "The Merchant Center account's [shipping settings](https://support.google.com/merchants/answer/6069284). The `ShippingSettings` resource lets you retrieve and update the shipping settings of your advanced account and all its associated sub-accounts. For more information, see [Manage shipping settings](https://developers.google.com/merchant/api/guides/accounts/manage-shipping-settings).", "id": "ShippingSettings", "properties": { "etag": { @@ -5464,7 +5464,7 @@ false "type": "object" }, "TermsOfService": { -"description": "The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`.", +"description": "The `TermsOfService` message represents a specific version of the terms of service that merchants must accept to access certain features or services. For more information, see [Terms of Service](https://support.google.com/merchants/answer/160173). This message is important for the onboarding process, ensuring that merchants agree to the necessary legal agreements for using the service. Merchants can retrieve the latest terms of service for a given `kind` and `region` through `RetrieveLatestTermsOfService`, and accept them as required through `AcceptTermsOfService`. For step-by-step instructions, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements).", "id": "TermsOfService", "properties": { "external": { @@ -5499,7 +5499,7 @@ false "type": "object" }, "TermsOfServiceAgreementState": { -"description": "This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field.", +"description": "This resource represents the agreement state for a given account and terms of service kind. The state is as follows: * If the business has accepted a terms of service, `accepted` will be populated, otherwise it will be empty * If the business must sign a terms of service, `required` will be populated, otherwise it will be empty. Note that both `required` and `accepted` can be present. In this case the `accepted` terms of services will have an expiration date set in the `valid_until` field. The `required` terms of services need to be accepted before `valid_until` in order for the account to continue having a valid agreement. When accepting new terms of services we expect third-party providers to display the text associated with the given terms of service agreement (the url to the file containing the text is added in the Required message below as `tos_file_uri`). The actual acceptance of the terms of service is done by calling accept on the `TermsOfService` resource. `valid_until` field. For more information, see [Manage Terms of Service](https://developers.google.com/merchant/api/guides/accounts/manage-tos-agreements).", "id": "TermsOfServiceAgreementState", "properties": { "accepted": { @@ -5651,11 +5651,11 @@ false "type": "object" }, "User": { -"description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).", +"description": "The `User` resource represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472) and [Control access to your account](https://developers.google.com/merchant/api/guides/accounts/control-access).", "id": "User", "properties": { "accessRights": { -"description": "Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has.", +"description": "Required. The [access rights](https://support.google.com/merchants/answer/12160472#accesstypes) the user has.", "items": { "enum": [ "ACCESS_RIGHT_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json index 567dd7bb9a..a606fb63b0 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1.json @@ -295,7 +295,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { @@ -342,7 +342,7 @@ "type": "object" }, "ConversionSource": { -"description": "Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.", +"description": "Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources. For more information, see [Manage conversion sources](https://developers.google.com/merchant/api/guides/conversion-sources/overview).", "id": "ConversionSource", "properties": { "controller": { @@ -579,7 +579,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json index e07ffa8c1c..4fc7dcaa3a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1.json @@ -110,7 +110,7 @@ "dataSources": { "methods": { "create": { -"description": "Creates the new data source configuration for the given account. This method always creates a new data source.", +"description": "Creates the new data source configuration for the given account. This method always creates a new data source. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).", "flatPath": "datasources/v1/accounts/{accountsId}/dataSources", "httpMethod": "POST", "id": "merchantapi.accounts.dataSources.create", @@ -163,7 +163,7 @@ ] }, "fetch": { -"description": "Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set.", +"description": "Performs the data fetch immediately (even outside fetch schedule) on a data source from your Merchant Center Account. If you need to call this method more than once per day, you should use the Products service to update your product data instead. This method only works on data sources with a file input set. For more information, see [Monitor and trigger data source processing](https://developers.google.com/merchant/api/guides/data-sources/monitor-status).", "flatPath": "datasources/v1/accounts/{accountsId}/dataSources/{dataSourcesId}:fetch", "httpMethod": "POST", "id": "merchantapi.accounts.dataSources.fetch", @@ -321,11 +321,11 @@ } } }, -"revision": "20261104", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { -"description": "The [data source](/merchant/api/guides/data-sources/overview) for the Merchant Center account.", +"description": "The [data source](https://developers.google.com/merchant/api/guides/data-sources/overview) for the Merchant Center account. For more information, see [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).", "id": "DataSource", "properties": { "dataSourceId": { @@ -608,7 +608,7 @@ "type": "object" }, "FileUpload": { -"description": "The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources.", +"description": "The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources. For more information, see [Monitor and trigger data source processing](https://developers.google.com/merchant/api/guides/data-sources/monitor-status) and [Manage various data source types](https://developers.google.com/merchant/api/guides/data-sources/manage-various-data-sources).", "id": "FileUpload", "properties": { "dataSourceId": { @@ -764,22 +764,6 @@ "description": "The primary data source for local and online products.", "id": "PrimaryProductDataSource", "properties": { -"channel": { -"description": "Optional. Immutable. Specifies the type of data source channel.", -"enum": [ -"CHANNEL_UNSPECIFIED", -"ONLINE_PRODUCTS", -"LOCAL_PRODUCTS", -"PRODUCTS" -], -"enumDescriptions": [ -"Not specified.", -"Online product.", -"Local product.", -"Unified data source for both local and online products. Note: Products management through the API is not possible for this channel." -], -"type": "string" -}, "contentLanguage": { "description": "Optional. Immutable. The two-letter ISO 639-1 language of the items in the data source. `feedLabel` and `contentLanguage` must be either both set or unset. The fields can only be unset for data sources without file input. If set, the data source will only accept products matching this combination. If unset, the data source will accept products without that restriction.", "type": "string" @@ -912,7 +896,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json index 974eef8566..2881f7d785 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1.json @@ -137,7 +137,7 @@ ] }, "insert": { -"description": "Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products.", +"description": "Inserts a `LocalInventory` resource to a product in your merchant account. Replaces the full `LocalInventory` resource if an entry with the same `storeCode` already exists for the product. It might take up to 30 minutes for the new or updated `LocalInventory` resource to appear in products. For step-by-step instructions, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory).", "flatPath": "inventories/v1/accounts/{accountsId}/products/{productsId}/localInventories:insert", "httpMethod": "POST", "id": "merchantapi.accounts.products.localInventories.insert", @@ -230,7 +230,7 @@ ] }, "insert": { -"description": "Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products.", +"description": "Inserts a `RegionalInventory` to a given product in your merchant account. Replaces the full `RegionalInventory` resource if an entry with the same `region` already exists for the product. It might take up to 30 minutes for the new or updated `RegionalInventory` resource to appear in products. For step-by-step instructions, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory) and [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory).", "flatPath": "inventories/v1/accounts/{accountsId}/products/{productsId}/regionalInventories:insert", "httpMethod": "POST", "id": "merchantapi.accounts.products.regionalInventories.insert", @@ -300,7 +300,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { @@ -421,7 +421,7 @@ "type": "object" }, "LocalInventory": { -"description": "Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).", +"description": "Local inventory information for the product. Represents in-store information for a specific product at the store specified by `storeCode`. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342). For more information, see [Add local inventory](https://developers.google.com/merchant/api/guides/inventories/add-local-inventory) and [Update local inventory](https://developers.google.com/merchant/api/guides/inventories/update-local-inventory).", "id": "LocalInventory", "properties": { "account": { @@ -670,7 +670,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -736,7 +736,7 @@ false "type": "object" }, "RegionalInventory": { -"description": "Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880).", +"description": "Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific `region`. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880). For more information, see [Add regional inventory](https://developers.google.com/merchant/api/guides/inventories/add-regional-inventory), [Update regional inventory](https://developers.google.com/merchant/api/guides/inventories/update-regional-inventory), and [Create and update regions](https://developers.google.com/merchant/api/guides/accounts/regions).", "id": "RegionalInventory", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json index 3160b1b427..7a16816f5a 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.issueresolution_v1.json @@ -157,7 +157,7 @@ "issueresolution": { "methods": { "renderaccountissues": { -"description": "Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.", +"description": "Provide a list of business's account issues with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).", "flatPath": "issueresolution/v1/accounts/{accountsId}:renderaccountissues", "httpMethod": "POST", "id": "merchantapi.issueresolution.renderaccountissues", @@ -195,7 +195,7 @@ ] }, "renderproductissues": { -"description": "Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications.", +"description": "Provide a list of issues for business's product with an issue resolution content and available actions. This content and actions are meant to be rendered and shown in third-party applications. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).", "flatPath": "issueresolution/v1/accounts/{accountsId}/products/{productsId}:renderproductissues", "httpMethod": "POST", "id": "merchantapi.issueresolution.renderproductissues", @@ -233,7 +233,7 @@ ] }, "triggeraction": { -"description": "Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under \"What is the issue/question?\" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.", +"description": "Start an action. The action can be requested by a business in third-party application. Before the business can request the action, the third-party application needs to show them action specific content and display a user input form. Access to the `triggeraction` method is restricted to an allowlist. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under \"What is the issue/question?\" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).", "flatPath": "issueresolution/v1/accounts/{accountsId}:triggeraction", "httpMethod": "POST", "id": "merchantapi.issueresolution.triggeraction", @@ -268,7 +268,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Action": { @@ -380,7 +380,7 @@ "type": "object" }, "AggregateProductStatus": { -"description": "Aggregate product statuses for a given reporting context and country.", +"description": "Aggregate product statuses for a given reporting context and country. For more information, see [View Aggregate Product Statuses](https://developers.google.com/merchant/api/guides/accounts/aggregate-product-statuses).", "id": "AggregateProductStatus", "properties": { "country": { @@ -940,7 +940,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -1101,7 +1101,7 @@ false "type": "object" }, "RenderedIssue": { -"description": "An issue affecting specific business or their product.", +"description": "An issue affecting specific business or their product. For more information, see [Display issues and solutions to businesses](https://developers.google.com/merchant/api/guides/accounts/render-issues).", "id": "RenderedIssue", "properties": { "actions": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json index cd26b9a10a..0fed48803f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1.json @@ -327,7 +327,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CountrySettings": { @@ -451,7 +451,7 @@ "type": "object" }, "LfpInventory": { -"description": "Local Inventory for the merchant.", +"description": "Local Inventory for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview).", "id": "LfpInventory", "properties": { "availability": { @@ -468,7 +468,7 @@ "type": "string" }, "feedLabel": { -"description": "Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`.", +"description": "Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`.", "type": "string" }, "gtin": { @@ -518,7 +518,7 @@ "type": "object" }, "LfpMerchantState": { -"description": "The LFP state of a merchant.", +"description": "The LFP state of a merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview).", "id": "LfpMerchantState", "properties": { "countrySettings": { @@ -553,7 +553,7 @@ "type": "object" }, "LfpSale": { -"description": "A sale for the merchant.", +"description": "A sale for the merchant. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview).", "id": "LfpSale", "properties": { "contentLanguage": { @@ -561,7 +561,7 @@ "type": "string" }, "feedLabel": { -"description": "Optional. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the product. If this is not set, it will default to `regionCode`.", +"description": "Optional. The [feed label](https://developers.google.com/merchant/api/guides/data-sources/api-sources) for the product. If this is not set, it will default to `regionCode`.", "type": "string" }, "gtin": { @@ -613,7 +613,7 @@ "type": "object" }, "LfpStore": { -"description": "A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used.", +"description": "A store for the merchant. This will be used to match to a store under the Google Business Profile of the target merchant. If a matching store can't be found, the inventories or sales submitted with the store code will not be used. For more information, see [Manage local feeds partnership](https://developers.google.com/merchant/api/guides/local-feeds-partnership/overview).", "id": "LfpStore", "properties": { "gcidCategory": { @@ -837,7 +837,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json index 7c34de30f5..a17718cd2e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.loyaltycustomers_v1.json @@ -110,7 +110,7 @@ "loyaltyCustomers": { "methods": { "manage": { -"description": "Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.", +"description": "Manages (inserts, updates, or removes) a customer's loyalty tier information. This method serves as a single interface for all changes to a customer's loyalty status. The specific action (insert, update, or remove) is determined by the current state of the merchant-to-customer association and the `loyalty_tier` value provided in the request. For more information on how to use this method, see [Overview of the loyalty customer match service](https://developers.google.com/merchant/api/guides/loyalty/customer-match-service). **Operation Logic:** * **Upsert (Insert/Update):** Providing any valid tier other than `NON_MEMBER` will associate the customer with that tier. If an association already exists, it will be updated; otherwise, a new one will be created. * **Removal:** Setting `loyalty_tier` to `NON_MEMBER` will remove any existing loyalty association for the customer. **Privacy Note:** To protect user privacy, this method consistently returns a `200 OK` status with a default `LoyaltyCustomer` response if the customer's identifier cannot be matched to a Google account or if the user has not opted into loyalty personalization.", "flatPath": "loyaltyCustomers/v1/accounts/{accountsId}/loyaltyCustomers:manage", "httpMethod": "POST", "id": "merchantapi.accounts.loyaltyCustomers.manage", @@ -142,7 +142,7 @@ } } }, -"revision": "20260921", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AddressInfo": { @@ -333,7 +333,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json index 4330a7f63b..9d1939271c 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1.json @@ -110,7 +110,7 @@ "notificationsubscriptions": { "methods": { "create": { -"description": "Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", +"description": "Creates a notification subscription for a business. For standalone or sub-accounts, the business can create a subscription for self. For advanced accounts, the business can create a subscription for all managed accounts or for a specific subaccount. See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents. We will allow the following types of notification subscriptions to exist together (per business as a subscriber per event type): 1. Subscription for all managed accounts + subscription for self. 2. Multiple \"partial\" subscriptions for managed accounts + subscription for self. we will not allow (per business as a subscriber per event type): 1. Multiple self subscriptions. 2. Multiple \"all managed accounts\" subscriptions. 3. \"All managed accounts\" subscription and partial subscriptions at the same time. 4. Multiple partial subscriptions for the same target account.", "flatPath": "notifications/v1/accounts/{accountsId}/notificationsubscriptions", "httpMethod": "POST", "id": "merchantapi.accounts.notificationsubscriptions.create", @@ -262,7 +262,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { @@ -290,7 +290,7 @@ "type": "object" }, "NotificationSubscription": { -"description": "Represents a notification subscription owned by a Merchant account. See [Decode notifications](/merchant/api/guides/accounts/notifications#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.", +"description": "Represents a notification subscription owned by a Merchant account. For more information, see [Notifications overview](https://developers.google.com/merchant/api/guides/notifications/overview). See [Decode notifications](https://developers.google.com/merchant/api/guides/notifications/overview#decode_notifications) for information on how to decode the notification payload and how to interpret its contents.", "id": "NotificationSubscription", "properties": { "allManagedAccounts": { @@ -420,7 +420,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json index 8c41900420..30c99b96f0 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.ordertracking_v1.json @@ -147,7 +147,7 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DateTime": { @@ -241,7 +241,7 @@ "type": "object" }, "OrderTrackingSignal": { -"description": "Represents a business trade from which signals are extracted, such as shipping.", +"description": "Represents a business trade from which signals are extracted, such as shipping. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview).", "id": "OrderTrackingSignal", "properties": { "customerShippingFee": { @@ -264,7 +264,7 @@ "type": "array" }, "merchantId": { -"description": "Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).", +"description": "Optional. The Google Merchant Center ID of this order tracking signal. This value is optional. If left unset, the caller's Merchant Center ID is used. You must request access in order to provide data on behalf of another business. For more information, see [Manage order tracking signals](https://developers.google.com/merchant/api/guides/order/overview).", "format": "int64", "type": "string" }, @@ -408,7 +408,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index dc42f2b1aa..6606ab8d99 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -140,7 +140,7 @@ ] }, "insert": { -"description": "[Uploads a product input to your Merchant Center account](/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.", +"description": "[Uploads a product input to your Merchant Center account](https://developers.google.com/merchant/api/guides/products/add-manage#add_a_product). You must have a products [data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source) to be able to insert a product. The unique identifier of the data source is passed as a query parameter in the request URL. If a product input with the same contentLanguage, offerId, and dataSource already exists, then the product input inserted by this method replaces that entry. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.", "flatPath": "products/v1/accounts/{accountsId}/productInputs:insert", "httpMethod": "POST", "id": "merchantapi.accounts.productInputs.insert", @@ -149,7 +149,7 @@ ], "parameters": { "dataSource": { -"description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Create a primary data source](/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`.", +"description": "Required. The primary or supplemental product data source name. If the product already exists and data source provided is different, then the product will be moved to a new data source. For more information, see [Create a primary data source](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Only API data sources are supported. Format: `accounts/{account}/dataSources/{datasource}`. For example, `accounts/123456/dataSources/104628`.", "location": "query", "type": "string" }, @@ -173,7 +173,7 @@ ] }, "patch": { -"description": "Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.", +"description": "Updates the existing product input in your Merchant Center account. The name of the product input to update is taken from the `name` field within the `ProductInput` resource. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. For more information, see [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage) and [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates).", "flatPath": "products/v1/accounts/{accountsId}/productInputs/{productInputsId}", "httpMethod": "PATCH", "id": "merchantapi.accounts.productInputs.patch", @@ -241,7 +241,7 @@ ] }, "list": { -"description": "Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.", +"description": "Lists the processed products in your Merchant Center account. The response might contain fewer items than specified by `pageSize`. Rely on `pageToken` to determine if there are more items to be requested. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. For more information, see [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues).", "flatPath": "products/v1/accounts/{accountsId}/products", "httpMethod": "GET", "id": "merchantapi.accounts.products.list", @@ -281,7 +281,7 @@ } } }, -"revision": "20261106", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -1244,7 +1244,7 @@ false "type": "object" }, "Product": { -"description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions.", +"description": "The processed product, built from multiple product inputs after applying rules and supplemental data sources. This processed product matches what is shown in your Merchant Center account. Each product is built from exactly one primary data source product input, and multiple supplemental data source inputs. After inserting, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved. All fields in the processed product and its sub-messages match the name of their corresponding attribute in the [Product data specification](https://support.google.com/merchants/answer/7052112) with some exceptions. For product ingestion workflows and status checks, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), and [List your products data and product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues).", "id": "Product", "properties": { "archived": { @@ -2397,7 +2397,7 @@ false "type": "string" }, "sizeTypes": { -"description": "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).", +"description": "The cut of the item. It can be used to represent combined size types for apparel items. You can provide up to two `SizeType` values, for example, `[\"PETITE\", \"MATERNITY\"]` or `[\"BIG\", \"TALL\"]`. For more information, see [Size type](https://support.google.com/merchants/answer/6324497).", "items": { "enum": [ "SIZE_TYPE_UNSPECIFIED", @@ -2801,7 +2801,7 @@ false "type": "object" }, "ProductInput": { -"description": "This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](/merchant/api/guides/products/overview). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.", +"description": "This resource represents input data you submit for a product, not the processed product that you see in Merchant Center, in Shopping ads, or across Google surfaces. Product inputs, rules and supplemental data source data are combined to create the processed Product. For more information, see [Manage products](https://developers.google.com/merchant/api/guides/products/overview), [Add and manage products](https://developers.google.com/merchant/api/guides/products/add-manage), [Make frequent updates to your products](https://developers.google.com/merchant/api/guides/products/frequent-updates), and [Manage API data sources](https://developers.google.com/merchant/api/guides/data-sources/api-sources#create-primary-data-source). Required product input attributes to pass data validation checks are primarily defined in the [Products Data Specification](https://support.google.com/merchants/answer/188494). The following attributes are required: feedLabel, contentLanguage and offerId. After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved. All fields in the product input and its sub-messages match the English name of their corresponding attribute in the [Products Data Specification](https://support.google.com/merchants/answer/188494) with [some exceptions](https://support.google.com/merchants/answer/7052112). The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.", "id": "ProductInput", "properties": { "base64EncodedName": { @@ -2977,7 +2977,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json index fc25c7a198..d02c67c4f7 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1.json @@ -203,7 +203,7 @@ } } }, -"revision": "20261026", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -976,7 +976,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -1042,7 +1042,7 @@ false "type": "object" }, "Promotion": { -"description": "Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.", +"description": "Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. For more information, see [Manage promotions](https://developers.google.com/merchant/api/guides/promotions/overview) and [Troubleshoot issues](https://developers.google.com/merchant/api/guides/promotions/troubleshooting).", "id": "Promotion", "properties": { "attributes": { @@ -1050,7 +1050,7 @@ false "description": "Optional. A list of promotion attributes." }, "contentLanguage": { -"description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281?ref_topic=6396150&sjid=18314938579342094533-NC#option3&zippy=).", +"description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the promotion. Promotions is only for [selected languages](https://support.google.com/merchants/answer/4588281#option3&zippy=).", "type": "string" }, "customAttributes": { @@ -1070,7 +1070,7 @@ false "type": "string" }, "promotionId": { -"description": "Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148?ref_topic=7322920&sjid=871860036916537104-NC#minimum_requirements) to prevent promotion disapprovals.", +"description": "Required. The user provided promotion ID to uniquely identify the promotion. Follow [minimum requirements](https://support.google.com/merchants/answer/7050148#minimum_requirements) to prevent promotion disapprovals.", "type": "string" }, "promotionStatus": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json index f41355f314..c6ae110a3d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1.json @@ -220,11 +220,11 @@ } } }, -"revision": "20260901", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AccountLimit": { -"description": "A limit of a certain type that is applied to an account.", +"description": "A limit of a certain type that is applied to an account. For more information, see [Quotas and limits overview](https://developers.google.com/merchant/api/guides/quotas-limits/overview) and [Merchant Center limits](https://developers.google.com/merchant/api/guides/quotas-limits/limits).", "id": "AccountLimit", "properties": { "name": { @@ -420,7 +420,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -486,7 +486,7 @@ false "type": "object" }, "QuotaGroup": { -"description": "The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.", +"description": "The group information for methods in the Merchant API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned. For more information, see [Quotas and limits overview](https://developers.google.com/merchant/api/guides/quotas-limits/overview) and [Quotas](https://developers.google.com/merchant/api/guides/quotas-limits/quotas).", "id": "QuotaGroup", "properties": { "methodDetails": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json index 868bf429b9..4e61b99473 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1.json @@ -110,7 +110,7 @@ "reports": { "methods": { "search": { -"description": "Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested.", +"description": "Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested. For more information, see [Get started](https://developers.google.com/merchant/api/guides/reports/get-started), [Use Merchant Center Query Language](https://developers.google.com/merchant/api/guides/reports/query-language), and [Paginate query results](https://developers.google.com/merchant/api/guides/reports/paging).", "flatPath": "reports/v1/accounts/{accountsId}/reports:search", "httpMethod": "POST", "id": "merchantapi.accounts.reports.search", @@ -142,11 +142,11 @@ } } }, -"revision": "20261026", +"revision": "20261110", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { -"description": "Fields available for query in `best_sellers_brand_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top brands. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `best_sellers_brand_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top brands. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market).", "id": "BestSellersBrandView", "properties": { "brand": { @@ -250,7 +250,7 @@ "type": "object" }, "BestSellersProductClusterView": { -"description": "Fields available for query in `best_sellers_product_cluster_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `best_sellers_product_cluster_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market).", "id": "BestSellersProductClusterView", "properties": { "brand": { @@ -417,7 +417,7 @@ "type": "object" }, "CompetitiveVisibilityBenchmarkView": { -"description": "Fields available for query in `competitive_visibility_benchmark_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with the category benchmark. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `competitive_visibility_benchmark_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with the category benchmark. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape).", "id": "CompetitiveVisibilityBenchmarkView", "properties": { "categoryBenchmarkVisibilityTrend": { @@ -463,7 +463,7 @@ "type": "object" }, "CompetitiveVisibilityCompetitorView": { -"description": "Fields available for query in `competitive_visibility_competitor_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `competitive_visibility_competitor_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape).", "id": "CompetitiveVisibilityCompetitorView", "properties": { "adsOrganicRatio": { @@ -532,7 +532,7 @@ "type": "object" }, "CompetitiveVisibilityTopMerchantView": { -"description": "Fields available for query in `competitive_visibility_top_merchant_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with business with highest visibility. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `competitive_visibility_top_merchant_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with business with highest visibility. Values are only set for fields requested explicitly in the request's search query. For more information, see [Explore your competitive landscape](https://developers.google.com/merchant/api/guides/reports/explore-competitive-landscape).", "id": "CompetitiveVisibilityTopMerchantView", "properties": { "adsOrganicRatio": { @@ -779,14 +779,14 @@ false "type": "string" }, "code": { -"description": "Error code of the issue, equivalent to the `code` of [Product issues](https://developers.google.com/shopping-content/guides/product-issues).", +"description": "Error code of the issue, equivalent to the `code` of [Product issues](https://developers.google.com/merchant/api/guides/products/list-products-data-issues).", "type": "string" } }, "type": "object" }, "NonProductPerformanceView": { -"description": "Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information, see [Performance reports](https://developers.google.com/merchant/api/guides/reports/performance-reports).", "id": "NonProductPerformanceView", "properties": { "clickThroughRate": { @@ -832,7 +832,7 @@ false "type": "object" }, "PriceCompetitivenessProductView": { -"description": "Fields available for query in `price_competitiveness_product_view` table. [Price competitiveness](https://support.google.com/merchants/answer/9626903) report. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `price_competitiveness_product_view` table. [Price competitiveness](https://support.google.com/merchants/answer/9626903) report. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market).", "id": "PriceCompetitivenessProductView", "properties": { "benchmarkPrice": { @@ -907,7 +907,7 @@ false "type": "object" }, "PriceInsightsProductView": { -"description": "Fields available for query in `price_insights_product_view` table. [Price insights](https://support.google.com/merchants/answer/11916926) report. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `price_insights_product_view` table. [Price insights](https://support.google.com/merchants/answer/11916926) report. Values are only set for fields requested explicitly in the request's search query. For more information, see [Understand the market](https://developers.google.com/merchant/api/guides/reports/understand-the-market).", "id": "PriceInsightsProductView", "properties": { "brand": { @@ -1101,7 +1101,7 @@ false "type": "object" }, "ProductPerformanceView": { -"description": "Fields available for query in `product_performance_view` table. Product performance data for your account, including performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `offer_id`). Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `product_performance_view` table. Product performance data for your account, including performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `offer_id`). Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information, see [Performance reports](https://developers.google.com/merchant/api/guides/reports/performance-reports).", "id": "ProductPerformanceView", "properties": { "brand": { @@ -1109,23 +1109,23 @@ false "type": "string" }, "categoryL1": { -"description": "[Product category (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", +"description": "[Product category (1st level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "categoryL2": { -"description": "[Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", +"description": "[Product category (2nd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "categoryL3": { -"description": "[Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", +"description": "[Product category (3rd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "categoryL4": { -"description": "[Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", +"description": "[Product category (4th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "categoryL5": { -"description": "[Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", +"description": "[Product category (5th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "clickThroughRate": { @@ -1238,23 +1238,23 @@ false "type": "string" }, "productTypeL1": { -"description": "[Product type (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", +"description": "[Product type (1st level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "productTypeL2": { -"description": "[Product type (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", +"description": "[Product type (2nd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "productTypeL3": { -"description": "[Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", +"description": "[Product type (3rd level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "productTypeL4": { -"description": "[Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", +"description": "[Product type (4th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "productTypeL5": { -"description": "[Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", +"description": "[Product type (5th level)](https://developers.google.com/merchant/api/guides/reports/performance-reports#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "storeType": { @@ -1283,7 +1283,7 @@ false "type": "object" }, "ProductStatusChangeMessage": { -"description": "The message that the merchant will receive to notify about product status change event", +"description": "The message that the merchant will receive to notify about product status change event. For more information, see [Product status changes](https://developers.google.com/merchant/api/guides/notifications/product-status-changes).", "id": "ProductStatusChangeMessage", "properties": { "account": { @@ -1349,7 +1349,7 @@ false "type": "object" }, "ProductView": { -"description": "Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.", +"description": "Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. For more information, see [Evaluate your products](https://developers.google.com/merchant/api/guides/reports/evaluate-products).", "id": "ProductView", "properties": { "aggregatedReportingContextStatus": { @@ -1600,7 +1600,7 @@ false "type": "object" }, "ReportRow": { -"description": "Result row returned from the search query. Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated.", +"description": "Result row returned from the search query. Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated. For more information, see [Reports overview](https://developers.google.com/merchant/api/guides/reports/overview) and [Use Merchant Center Query Language](https://developers.google.com/merchant/api/guides/reports/query-language).", "id": "ReportRow", "properties": { "bestSellersBrandView": { @@ -1660,7 +1660,7 @@ false "type": "string" }, "query": { -"description": "Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.", +"description": "Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index 6b2fcd41af..8b2d6ca919 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20261026", +"revision": "20261109", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1178,7 +1178,8 @@ "type": "boolean" }, "canHaveBusinessCalls": { -"description": "Output only. Indicates if the listing is eligible for business calls.", +"deprecated": true, +"description": "Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.", "readOnly": true, "type": "boolean" }, @@ -1244,7 +1245,7 @@ "type": "string" }, "placeId": { -"description": "Output only. If this locationappears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.", +"description": "Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.", "readOnly": true, "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1alpha.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1alpha.json new file mode 100644 index 0000000000..1b42dd8848 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1alpha.json @@ -0,0 +1,2062 @@ +{ +"basePath": "", +"baseUrl": "https://mybusinessbusinessinformation.googleapis.com/", +"batchPath": "batch", +"canonicalName": "My Business Business Information", +"description": "The My Business Business Information API provides an interface for managing business information on Google. Note: If you have a quota of 0 after enabling the API, please request GBP API access at https://developers.google.com/my-business/content/prereqs#request-access. ", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/my-business/", +"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": "mybusinessbusinessinformation:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://mybusinessbusinessinformation.mtls.googleapis.com/", +"name": "mybusinessbusinessinformation", +"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": { +"accounts": { +"resources": { +"locations": { +"methods": { +"create": { +"description": "Creates a new Location that will be owned by the logged in user.", +"flatPath": "v1alpha/accounts/{accountsId}/locations", +"httpMethod": "POST", +"id": "mybusinessbusinessinformation.accounts.locations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the account in which to create this location.", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. A unique request ID for the server to detect duplicated requests. We recommend using UUIDs. Max length is 50 characters.", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request is validated without actually creating the location.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/locations", +"request": { +"$ref": "Location" +}, +"response": { +"$ref": "Location" +} +}, +"list": { +"description": "Lists the locations for the specified account.", +"flatPath": "v1alpha/accounts/{accountsId}/locations", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.accounts.locations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. A filter constraining the locations to return. The response includes only entries that match the filter. If `filter` is empty, then constraints are applied and all locations (paginated) are retrieved for the requested account. For more information about valid fields and example usage, see [Work with Location Data Guide](https://developers.google.com/my-business/content/location-data#filter_results_when_you_list_locations).", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Sorting order for the request. Multiple fields should be comma-separated, following SQL syntax. The default sorting order is ascending. To specify descending order, a suffix \" desc\" should be added. Valid fields to order_by are title and store_code. For example: \"title, store_code desc\" or \"title\" or \"store_code desc\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. How many locations to fetch per page. Default value is 10 if not set. Minimum is 1, and maximum page size is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If specified, it fetches the next `page` of locations. The page token is returned by previous calls to `ListLocations` when there were more locations than could fit in the requested page size.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the account to fetch locations from. * **Specific Account ID**: If the account is of type `AccountType.PERSONAL`, the response returns only locations directly owned by that account. For all other types (e.g., `AccountType.LOCATION_GROUP`), it returns all accessible locations. * **Wildcard (`-`)**: Using `accounts/-` identifies the authenticated user. This scope defaults to `AccountType.PERSONAL` but includes both directly and indirectly owned locations (e.g., those accessible via member groups).", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Required. Read mask to specify what fields will be returned in the response.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+parent}/locations", +"response": { +"$ref": "ListLocationsResponse" +} +} +} +} +} +}, +"attributes": { +"methods": { +"list": { +"description": "Returns the list of attributes that would be available for a location with the given primary category and country.", +"flatPath": "v1alpha/attributes", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.attributes.list", +"parameterOrder": [], +"parameters": { +"categoryName": { +"description": "Optional. The primary category stable ID to find available attributes. Must be of the format `categories/{category_id}` (e.g., `categories/gcid:restaurant`). Required if `parent` is not set and `show_all` is false.", +"location": "query", +"type": "string" +}, +"languageCode": { +"description": "Optional. The BCP 47 code of language to get attribute display names in. If this language is not available, they will be provided in English.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "How many attributes to include per page. Default is 200, minimum is 1.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "If specified, the next page of attribute metadata is retrieved.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Optional. Resource name of the location to look up available attributes. If this field is set, `category_name`, `region_code`, `language_code` and `show_all` are not required and must not be set. Format: `locations/{location_id}` (e.g., `locations/1234567890`).", +"location": "query", +"type": "string" +}, +"regionCode": { +"description": "Optional. The ISO 3166-1 alpha-2 country code to find available attributes. Required if `parent` is not set.", +"location": "query", +"type": "string" +}, +"showAll": { +"description": "Optional. If set to true, metadata for all available attributes are returned, disregarding `parent` and `category_name` fields. `language_code` and `region_code` are required when `show_all` is set to true.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/attributes", +"response": { +"$ref": "ListAttributeMetadataResponse" +} +} +} +}, +"categories": { +"methods": { +"batchGet": { +"description": "Returns a list of business categories for the provided language and GConcept ids.", +"flatPath": "v1alpha/categories:batchGet", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.categories.batchGet", +"parameterOrder": [], +"parameters": { +"languageCode": { +"description": "Required. The BCP 47 code of language that the category names should be returned in.", +"location": "query", +"type": "string" +}, +"names": { +"description": "Required. At least one name must be set. The GConcept ids the localized category names should be returned for. To return details for more than one category, repeat this parameter in the request.", +"location": "query", +"repeated": true, +"type": "string" +}, +"regionCode": { +"description": "Optional. The ISO 3166-1 alpha-2 country code used to infer non-standard language.", +"location": "query", +"type": "string" +}, +"view": { +"description": "Required. Specifies which parts to the Category resource should be returned in the response.", +"enum": [ +"CATEGORY_VIEW_UNSPECIFIED", +"BASIC", +"FULL" +], +"enumDescriptions": [ +"Not specified, equivalent to CATEGORY_METADATA_ONLY.", +"The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.", +"Returns all the fields in the response." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/categories:batchGet", +"response": { +"$ref": "BatchGetCategoriesResponse" +} +}, +"list": { +"description": "Returns a list of business categories. Search will match the category name but not the category ID. Search only matches the front of a category name (that is, 'food' may return 'Food Court' but not 'Fast Food Restaurant').", +"flatPath": "v1alpha/categories", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.categories.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. Filter string from user. The only field that supported is `displayName`. Eg: `filter=displayName=foo`.", +"location": "query", +"type": "string" +}, +"languageCode": { +"description": "Required. The BCP 47 code of language.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. How many categories to fetch per page. Default is 100, minimum is 1, and maximum page size is 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If specified, the next page of categories will be fetched.", +"location": "query", +"type": "string" +}, +"regionCode": { +"description": "Required. The ISO 3166-1 alpha-2 country code.", +"location": "query", +"type": "string" +}, +"view": { +"description": "Required. Specifies which parts to the Category resource should be returned in the response.", +"enum": [ +"CATEGORY_VIEW_UNSPECIFIED", +"BASIC", +"FULL" +], +"enumDescriptions": [ +"Not specified, equivalent to CATEGORY_METADATA_ONLY.", +"The server response will only include Category fields display_name, category_id and language_code. It omits any service type metadata related fields.", +"Returns all the fields in the response." +], +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/categories", +"response": { +"$ref": "ListCategoriesResponse" +} +} +} +}, +"chains": { +"methods": { +"get": { +"description": "Gets the specified chain. Returns `NOT_FOUND` if the chain does not exist.", +"flatPath": "v1alpha/chains/{chainsId}", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.chains.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The chain's resource name, in the format `chains/{chain_place_id}`.", +"location": "path", +"pattern": "^chains/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Chain" +} +}, +"search": { +"description": "Searches the chain based on chain name.", +"flatPath": "v1alpha/chains:search", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.chains.search", +"parameterOrder": [], +"parameters": { +"chainName": { +"description": "Required. Search for a chain by its name. Exact/partial/fuzzy/related queries are supported. Examples: \"walmart\", \"wal-mart\", \"walmmmart\", \"\u6c83\u5c14\u739b\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "The maximum number of matched chains to return from this query. The default is 10. The maximum possible value is 500.", +"format": "int32", +"location": "query", +"type": "integer" +} +}, +"path": "v1alpha/chains:search", +"response": { +"$ref": "SearchChainsResponse" +} +} +} +}, +"googleLocations": { +"methods": { +"search": { +"description": "Search all of the possible locations that are a match to the specified request.", +"flatPath": "v1alpha/googleLocations:search", +"httpMethod": "POST", +"id": "mybusinessbusinessinformation.googleLocations.search", +"parameterOrder": [], +"parameters": {}, +"path": "v1alpha/googleLocations:search", +"request": { +"$ref": "SearchGoogleLocationsRequest" +}, +"response": { +"$ref": "SearchGoogleLocationsResponse" +} +} +} +}, +"locations": { +"methods": { +"delete": { +"description": "Deletes a location. If this location cannot be deleted using the API and it is marked so in the `google.mybusiness.businessinformation.v1.LocationState`, use the [Google Business Profile](https://business.google.com/manage/) website.", +"flatPath": "v1alpha/locations/{locationsId}", +"httpMethod": "DELETE", +"id": "mybusinessbusinessinformation.locations.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the location to delete.", +"location": "path", +"pattern": "^locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +} +}, +"get": { +"description": "Returns the specified location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.", +"flatPath": "v1alpha/locations/{locationsId}", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the location to fetch.", +"location": "path", +"pattern": "^locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Required. Read mask to specify what fields will be returned in the response.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Location" +} +}, +"getAttributes": { +"description": "Retrieves attributes for a location as last set by the merchant. It may not reflect updates from Google or user-generated content that are live on Google Maps.", +"flatPath": "v1alpha/locations/{locationsId}/attributes", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.getAttributes", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"location": "path", +"pattern": "^locations/[^/]+/attributes$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Attributes" +} +}, +"getExtended": { +"description": "Returns the specified location with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes a mapping of field paths to metadata describing the current state of edits on that field, its origin source, and rejection details.", +"flatPath": "v1alpha/locations/{locationsId}:getExtended", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.getExtended", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the location to fetch.", +"location": "path", +"pattern": "^locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:getExtended", +"response": { +"$ref": "ExtendedLocation" +} +}, +"getGoogleUpdated": { +"description": "Returns the specified location as it appears live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version. The returned GoogleUpdatedLocation contains masks that indicate which fields differ from the merchant's information.", +"flatPath": "v1alpha/locations/{locationsId}:getGoogleUpdated", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.getGoogleUpdated", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the location to fetch.", +"location": "path", +"pattern": "^locations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Required. Read mask to specify what fields will be returned in the response.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}:getGoogleUpdated", +"response": { +"$ref": "GoogleUpdatedLocation" +} +}, +"patch": { +"description": "Updates the specified location.", +"flatPath": "v1alpha/locations/{locationsId}", +"httpMethod": "PATCH", +"id": "mybusinessbusinessinformation.locations.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. Google identifier for this location in the form: `locations/{location_id}`.", +"location": "path", +"pattern": "^locations/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The specific fields to update.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"validateOnly": { +"description": "Optional. If true, the request is validated without actually updating the location. When this field is set, we will only return validation errors if there were any. The response will be empty if no errors were found.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Location" +}, +"response": { +"$ref": "Location" +} +}, +"updateAttributes": { +"description": "Update attributes for a given location.", +"flatPath": "v1alpha/locations/{locationsId}/attributes", +"httpMethod": "PATCH", +"id": "mybusinessbusinessinformation.locations.updateAttributes", +"parameterOrder": [ +"name" +], +"parameters": { +"attributeMask": { +"description": "Required. Attribute name of attributes that you'd like to update. Represented by `attributes/{attribute}`. Updates: All attributes provided in the attributes field that you would like to update must be set in the `attribute_mask`. Attributes set in the above list but not in the `attribute_mask` will be ignored. Deletes: If you'd like to delete certain attributes, they must be specified in the `attribute_mask` with no matching entry in the attributes list. If you'd like to delete all attributes set on a location, you should look up all the applicable attributes for the location and then add them to the `attribute_mask` with an empty attributes field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +}, +"name": { +"description": "Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"location": "path", +"pattern": "^locations/[^/]+/attributes$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Attributes" +}, +"response": { +"$ref": "Attributes" +} +} +}, +"resources": { +"attributes": { +"methods": { +"getExtended": { +"description": "Returns the specified attributes with extended metadata. This includes both the merchant-provided data and the consumer-facing view, which may differ. It also includes metadata describing the current state of edits on each attribute, its origin source, and rejection details.", +"flatPath": "v1alpha/locations/{locationsId}/attributes:getExtended", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.attributes.getExtended", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"location": "path", +"pattern": "^locations/[^/]+/attributes$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:getExtended", +"response": { +"$ref": "ExtendedAttributes" +} +}, +"getGoogleUpdated": { +"description": "Retrieves attributes for a location as they appear live on Google Maps and Search. This consumer-facing view may have been updated by Google or user-generated content and may differ from the merchant's version.", +"flatPath": "v1alpha/locations/{locationsId}/attributes:getGoogleUpdated", +"httpMethod": "GET", +"id": "mybusinessbusinessinformation.locations.attributes.getGoogleUpdated", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"location": "path", +"pattern": "^locations/[^/]+/attributes$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:getGoogleUpdated", +"response": { +"$ref": "Attributes" +} +} +} +} +} +} +}, +"revision": "20261109", +"rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", +"schemas": { +"AdWordsLocationExtensions": { +"description": "Additional information that is surfaced in AdWords.", +"id": "AdWordsLocationExtensions", +"properties": { +"adPhone": { +"description": "Required. An alternate phone number to display on AdWords location extensions instead of the location's primary phone number.", +"type": "string" +} +}, +"type": "object" +}, +"Attribute": { +"description": "A location attribute. Attributes provide additional information about a location. The attributes that can be set on a location may vary based on the properties of that location (for example, category). Available attributes are determined by Google and may be added and removed without API changes.", +"id": "Attribute", +"properties": { +"name": { +"description": "Required. The resource name for this attribute.", +"type": "string" +}, +"repeatedEnumValue": { +"$ref": "RepeatedEnumAttributeValue", +"description": "When the attribute value type is REPEATED_ENUM, this contains the attribute value, and the other values fields must be empty." +}, +"uriValues": { +"description": "When the attribute value type is URL, this field contains the value(s) for this attribute, and the other values fields must be empty.", +"items": { +"$ref": "UriAttributeValue" +}, +"type": "array" +}, +"valueType": { +"description": "Output only. The type of value that this attribute contains. This should be used to determine how to interpret the value.", +"enum": [ +"ATTRIBUTE_VALUE_TYPE_UNSPECIFIED", +"BOOL", +"ENUM", +"URL", +"REPEATED_ENUM" +], +"enumDescriptions": [ +"Not specified.", +"The values for this attribute are boolean values.", +"The attribute has a predetermined list of available values that can be used. Metadata for this attribute will list these values.", +"The values for this attribute are URLs.", +"The attribute value is an enum with multiple possible values that can be explicitly set or unset." +], +"readOnly": true, +"type": "string" +}, +"values": { +"description": "The values for this attribute. The type of the values supplied must match that expected for that attribute. This is a repeated field where multiple attribute values may be provided. Attribute types only support one value.", +"items": { +"type": "any" +}, +"type": "array" +} +}, +"type": "object" +}, +"AttributeMetadata": { +"description": "Metadata for an attribute. Contains display information for the attribute, including a localized name and a heading for grouping related attributes together.", +"id": "AttributeMetadata", +"properties": { +"deprecated": { +"description": "If true, the attribute is deprecated and should no longer be used. If deprecated, updating this attribute will not result in an error, but updates will not be saved. At some point after being deprecated, the attribute will be removed entirely and it will become an error.", +"type": "boolean" +}, +"displayName": { +"description": "The localized display name for the attribute, if available; otherwise, the English display name.", +"type": "string" +}, +"groupDisplayName": { +"description": "The localized display name of the group that contains this attribute, if available; otherwise, the English group name. Related attributes are collected into a group and should be displayed together under the heading given here.", +"type": "string" +}, +"parent": { +"description": "The unique identifier for the attribute.", +"type": "string" +}, +"repeatable": { +"description": "If true, the attribute supports multiple values. If false, only a single value should be provided.", +"type": "boolean" +}, +"valueMetadata": { +"description": "For some types of attributes (for example, enums), a list of supported values and corresponding display names for those values is provided.", +"items": { +"$ref": "AttributeValueMetadata" +}, +"type": "array" +}, +"valueType": { +"description": "The value type for the attribute. Values set and retrieved should be expected to be of this type.", +"enum": [ +"ATTRIBUTE_VALUE_TYPE_UNSPECIFIED", +"BOOL", +"ENUM", +"URL", +"REPEATED_ENUM" +], +"enumDescriptions": [ +"Not specified.", +"The values for this attribute are boolean values.", +"The attribute has a predetermined list of available values that can be used. Metadata for this attribute will list these values.", +"The values for this attribute are URLs.", +"The attribute value is an enum with multiple possible values that can be explicitly set or unset." +], +"type": "string" +} +}, +"type": "object" +}, +"AttributeValueMetadata": { +"description": "Metadata for supported attribute values.", +"id": "AttributeValueMetadata", +"properties": { +"displayName": { +"description": "The display name for this value, localized where available; otherwise, in English. The value display name is intended to be used in context with the attribute display name. For example, for a \"WiFi\" enum attribute, this could contain \"Paid\" to represent paid Wi-Fi.", +"type": "string" +}, +"value": { +"description": "The attribute value.", +"type": "any" +} +}, +"type": "object" +}, +"Attributes": { +"description": "A container for all the attributes for a given location.", +"id": "Attributes", +"properties": { +"attributes": { +"description": "A collection of attributes that need to be updated.", +"items": { +"$ref": "Attribute" +}, +"type": "array" +}, +"name": { +"description": "Required. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"type": "string" +} +}, +"type": "object" +}, +"BatchGetCategoriesResponse": { +"description": "Response message for BusinessCategories.BatchGetBusinessCategories.", +"id": "BatchGetCategoriesResponse", +"properties": { +"categories": { +"description": "Categories that match the GConcept ids provided in the request. They will not come in the same order as category ids in the request.", +"items": { +"$ref": "Category" +}, +"type": "array" +} +}, +"type": "object" +}, +"BusinessHours": { +"description": "Represents the time periods that this location is open for business. Holds a collection of TimePeriod instances.", +"id": "BusinessHours", +"properties": { +"periods": { +"description": "Required. A collection of times that this location is open for business. Each period represents a range of hours when the location is open during the week.", +"items": { +"$ref": "TimePeriod" +}, +"type": "array" +} +}, +"type": "object" +}, +"Categories": { +"description": "A collection of categories that describes the business. During updates, both fields must be set. Clients are prohibited from individually updating the primary or additional categories using the update mask.", +"id": "Categories", +"properties": { +"additionalCategories": { +"description": "Optional. Additional categories to describe your business. Categories help your customers find accurate, specific results for services they're interested in. To keep your business information accurate and live, make sure that you use as few categories as possible to describe your overall core business. Choose categories that are as specific as possible, but representative of your main business.", +"items": { +"$ref": "Category" +}, +"type": "array" +}, +"primaryCategory": { +"$ref": "Category", +"description": "Required. Category that best describes the core business this location engages in." +} +}, +"type": "object" +}, +"Category": { +"description": "A category describing what this business is (not what it does). For a list of valid category IDs, and the mappings to their human-readable names, see `categories.list`.", +"id": "Category", +"properties": { +"displayName": { +"description": "Output only. The human-readable name of the category. This is set when reading the location. When modifying the location, `category_id` must be set.", +"readOnly": true, +"type": "string" +}, +"moreHoursTypes": { +"description": "Output only. More hours types that are available for this business category.", +"items": { +"$ref": "MoreHoursType" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Required. A stable ID (provided by Google) for this category. The value must be specified when modifying the category (when creating or updating a location).", +"type": "string" +}, +"serviceTypes": { +"description": "Output only. A list of all the service types that are available for this business category.", +"items": { +"$ref": "ServiceType" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, +"Chain": { +"description": "A chain is a brand that your business's locations can be affiliated with.", +"id": "Chain", +"properties": { +"chainNames": { +"description": "Names of the chain.", +"items": { +"$ref": "ChainName" +}, +"type": "array" +}, +"locationCount": { +"description": "Number of locations that are part of this chain.", +"format": "int32", +"type": "integer" +}, +"name": { +"description": "Required. The chain's resource name, in the format `chains/{chain_id}`.", +"type": "string" +}, +"websites": { +"description": "Websites of the chain.", +"items": { +"$ref": "ChainUri" +}, +"type": "array" +} +}, +"type": "object" +}, +"ChainName": { +"description": "Name to be used when displaying the chain.", +"id": "ChainName", +"properties": { +"displayName": { +"description": "The display name for this chain.", +"type": "string" +}, +"languageCode": { +"description": "The BCP 47 code of language of the name.", +"type": "string" +} +}, +"type": "object" +}, +"ChainUri": { +"description": "Url to be used when displaying the chain.", +"id": "ChainUri", +"properties": { +"uri": { +"description": "The uri for this chain.", +"type": "string" +} +}, +"type": "object" +}, +"Date": { +"description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", +"id": "Date", +"properties": { +"day": { +"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", +"format": "int32", +"type": "integer" +}, +"month": { +"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", +"format": "int32", +"type": "integer" +}, +"year": { +"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"ExtendedAttribute": { +"description": "Represents an attribute along with its edit metadata and current serving state.", +"id": "ExtendedAttribute", +"properties": { +"attributeProvidedByMerchant": { +"$ref": "Attribute", +"description": "Output only. The underlying attribute data managed by the merchant.", +"readOnly": true +}, +"attributeSeenByConsumers": { +"$ref": "Attribute", +"description": "Output only. The attribute data currently visible to consumers on Google Maps and Search.", +"readOnly": true +}, +"extendedFieldData": { +"$ref": "ExtendedFieldData", +"description": "Output only. Detailed edit status and metadata for this specific attribute.", +"readOnly": true +} +}, +"type": "object" +}, +"ExtendedAttributes": { +"description": "Response message for AttributesService.GetExtendedAttributes.", +"id": "ExtendedAttributes", +"properties": { +"extendedAttributes": { +"description": "Output only. The attributes with extended metadata.", +"items": { +"$ref": "ExtendedAttribute" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Output only. Google identifier for this location in the form of `locations/{location_id}/attributes`.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExtendedFieldData": { +"description": "Represents detailed metadata for an edit on a specific field/attribute.", +"id": "ExtendedFieldData", +"properties": { +"lastEditLifecycleStage": { +"description": "Output only. The current lifecycle stage of the merchant's most recent edit on this value.", +"enum": [ +"EDIT_LIFECYCLE_STAGE_UNSPECIFIED", +"EDIT_LIFECYCLE_STAGE_PENDING", +"EDIT_LIFECYCLE_STAGE_ACCEPTED", +"EDIT_LIFECYCLE_STAGE_REJECTED", +"EDIT_LIFECYCLE_STAGE_UPDATED_BY_GOOGLE", +"EDIT_LIFECYCLE_STAGE_DRAFT" +], +"enumDescriptions": [ +"Represents an unspecified lifecycle stage.", +"The edit is pending moderation or review.", +"The edit is accepted and published.", +"The edit has been rejected during moderation.", +"The edit was superseded by a value from another source which is now live.", +"A draft that has not been submitted for moderation, because the location is not yet verified." +], +"readOnly": true, +"type": "string" +}, +"rejectionReason": { +"description": "Output only. Reason for rejection, only populated if `last_edit_lifecycle_stage` is `EDIT_LIFECYCLE_STAGE_REJECTED`.", +"enum": [ +"POLICY_VIOLATION_UNSPECIFIED", +"ACCOUNT_RESTRICTED_AND_SUSPENDED", +"ACCOUNT_RESTRICTED_AND_EDIT_REJECTED", +"ASSOCIATED_ACCOUNT_SUSPENDED", +"BUSINESS_INELIGIBLE", +"OWNERSHIP_REVOKED", +"LOCATION_SUSPENDED", +"LOCATION_DISABLED", +"LOCATION_VERIFICATION_REQUIRED", +"PO_BOX", +"GOOGLE_PAY_SUSPENSION", +"EDITING_RESTRICTION", +"ILLEGAL_BUSINESS_HOURS_EDIT", +"FAKE_ENGAGEMENT", +"ADULT_THEMED", +"SEXUALLY_EXPLICIT", +"ADVERTISING_AND_SOLICITATION", +"DANGEROUS", +"GIBBERISH_AND_REPETITIVE", +"REPETITIVE", +"UNCLEAR", +"ILLEGAL", +"OFF_TOPIC", +"OFFENSIVE", +"VIOLENCE_AND_GORE", +"CHILD_SAFETY", +"HARASSMENT", +"HATE_SPEECH", +"IMPERSONATION", +"MISINFORMATION", +"MISREPRESENTATION", +"OBSCENITY_AND_PROFANITY", +"PERSONAL_INFO", +"REGULATED_GOODS_AND_SERVICES", +"GENERIC_VANDALISM", +"GENERIC_FRAUD", +"PHOTOS_AND_VIDEOS_CRITERIA", +"MODERATION_ERROR", +"PRIVACY", +"GENERIC_VIOLATION", +"GENERIC_QUALITY", +"IDENTITY_CHANGE", +"GEOGRAPHIC_LOCATION_CHANGE" +], +"enumDescriptions": [ +"Represents an unspecified policy violation.", +"A Google Account associated with this Business Profile has been placed under restriction, resulting in the suspension of the Business Profile.", +"A Google Account associated with this Business Profile has been placed under restriction, causing edits to be rejected. Unlike ACCOUNT_RESTRICTED_AND_SUSPENDED, the Business Profile itself remains active and is not suspended.", +"A Google Account associated with this Business Profile is not in good standing. Business Profiles associated with that account have been suspended.", +"Your business is not eligible for a Business Profile.", +"Another Google Account has claimed this Business Profile. You can no longer manage this profile.", +"This Business Profile has been suspended.", +"This Business Profile has been disabled.", +"This Business Profile is not verified.", +"Your Business Profile has been suspended because your business address can't be a PO box.", +"Business Profiles associated with your Payments profile have been suspended.", +"This Business Profile is currently restricted from receiving public updates. Google has turned editing for this location to prevent policy-violating content.", +"Your business category can't edit business hours.", +"Content that violates our policy on fake engagement isn't allowed. Fake engagement includes incentivized content, content intended to manipulate a place's rating, and other content that doesn't represent a genuine experience.", +"Content that violates our policy on adult-themed content isn't allowed. Adult themes include both non-explicit sexual content and other adult content.", +"Content that violates our policy on sexually explicit content isn't allowed. Sexually explicit content includes genital nudity or depictions or descriptions of sexual acts.", +"Content that violates our policy on advertising or solicitation isn't allowed. Advertising and solicitation includes promotional or commercial content, or content posted in exchange for benefits.", +"Content that violates our policy on dangerous content isn't allowed. Dangerous content promotes, facilitates, or encourages harmful acts.", +"Content that violates our policy on unclear or repetitive content isn't allowed. Unclear or repetitive content dilutes useful information others can find on Google.", +"Content that violates our policy on repetitive content isn't allowed. Repetitive content includes identical or similar content added multiple times by one or more accounts.", +"Content that violates our policy on unclear content isn't allowed. Unclear content includes random characters or other content that lacks meaning.", +"Content that violates our policy on illegal content isn't allowed.", +"Content that violates our policy on off-topic content isn't allowed. Off-topic content includes general, political, or social commentary, and personal rants.", +"Content that violates our policy on offensive content isn't allowed. Offensive content may reasonably cause another to experience extreme anger, insult, or disrespect.", +"Content that violates our policy on violence and gore isn't allowed. Violence and gore includes content involving people or animals that is extreme and depicts realistic acts of violence, blood, body parts, or viscera.", +"Content that violates our policy on child safety isn't allowed. This includes subject matter that puts children at risk, exploits or abuses children, or uses Google services to endanger children.", +"Content that violates our policy on harassment isn't allowed. This includes content that bullies, threatens, sexualizes, or causes a person to fear for their safety.", +"Content that violates our policy on hate speech isn't allowed. Hate speech includes promoting or condoning violence, discrimination, disparagement, or inciting hatred based on a protected characteristic or other characteristics associated with systemic discrimination or marginalization.", +"Content that violates our policy on impersonation isn't allowed. Impersonation includes assuming a false identity in order to mislead others or gain improper benefits.", +"Content that violates our policy on misinformation isn't allowed. Misinformation includes false or inaccurate information that may cause significant harm to individuals, businesses, or society.", +"Content that violates our policy on misrepresentation isn't allowed. Misrepresentation includes misleading representations or omissions for the purpose of gaining improper benefit.", +"Content that violates our policy on obscenity or profanity isn't allowed. Obscenity and profanity includes words or gestures that are locally considered socially offensive or vulgar.", +"Content that violates our policy on personal information isn't allowed. Personal information includes private or confidential information, such as credit card details, medical records, or government-issued identification, whether yours or someone else's.", +"Content that violates our policy on regulated goods and services isn't allowed. This includes featuring calls to action or offers for the sale of products or services that are subject to local legal regulations.", +"Content that violates our policies on abusive or low quality content isn't allowed.", +"Content that violates our policies on deceptive content and behavior isn't allowed. Deceptive content intentionally misleads or deceives others.", +"Content that doesn't follow our photo and video criteria isn't allowed.", +"An error occurred while processing your content.", +"Content that violates the Maps User Contributed Content privacy policy isn't allowed.", +"Your content violates our policies and isn't allowed.", +"Content that violates our policies on low quality content isn't allowed.", +"The change made by you is very different from the business created. This violates our policy.", +"Indicates the physical geographic location (address or latitude/longitude) of the business has changed significantly since the profile was created." +], +"readOnly": true, +"type": "string" +}, +"source": { +"description": "Output only. Origin source attribution of the most recent merchant edit. Not all edits will have a source specified.", +"enum": [ +"SOURCE_UNSPECIFIED", +"SOURCE_API", +"SOURCE_UI" +], +"enumDescriptions": [ +"Source attribution is unspecified.", +"The edit originated from an API client.", +"The edit originated from a Google Business Profile merchant UI surface (such as Google Search or Google Maps)." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp of when the merchant's most recent edit was submitted.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ExtendedLocation": { +"description": "Represents a location along with its edit metadata and current serving state.", +"id": "ExtendedLocation", +"properties": { +"extendedFieldData": { +"additionalProperties": { +"$ref": "ExtendedFieldData" +}, +"description": "Output only. Extended field data, keyed by the name of a top-level field of the `Location` resource. Keys are always plain top-level field names, never nested field paths. Each top-level field is treated atomically, so if you change a subfield, this map will treat it as a change to the top-level field.", +"readOnly": true, +"type": "object" +}, +"locationProvidedByMerchant": { +"$ref": "Location", +"description": "Output only. The underlying location data managed by the merchant.", +"readOnly": true +}, +"locationSeenByConsumers": { +"$ref": "Location", +"description": "Output only. The location data currently visible to consumers on Google Maps and Search.", +"readOnly": true +} +}, +"type": "object" +}, +"FreeFormServiceItem": { +"description": "Represents a free-form service offered by the merchant. These are services that are not exposed as part of our structure service data. The merchant manually enters the names for such services using a geomerchant surface.", +"id": "FreeFormServiceItem", +"properties": { +"category": { +"description": "Required. This field represents the category name (i.e. the category's stable ID). The `category` and `service_type_id` should match the possible combinations provided in the `Category` message.", +"type": "string" +}, +"label": { +"$ref": "Label", +"description": "Required. Language-tagged labels for the item. We recommend that item names be 140 characters or less, and descriptions 250 characters or less. This field should only be set if the input is a custom service item. Standardized service types should be updated using service_type_id." +} +}, +"type": "object" +}, +"GoogleLocation": { +"description": "Represents a Location that is present on Google. This can be a location that has been claimed by the user, someone else, or could be unclaimed.", +"id": "GoogleLocation", +"properties": { +"location": { +"$ref": "Location", +"description": "The sparsely populated Location information. This field can be re-used in CreateLocation if it is not currently claimed by a user." +}, +"name": { +"description": "Resource name of this GoogleLocation, in the format `googleLocations/{googleLocationId}`.", +"type": "string" +}, +"requestAdminRightsUri": { +"description": "A URL that will redirect the user to the request admin rights UI. This field is only present if the location has already been claimed by any user, including the current user.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleUpdatedLocation": { +"description": "Represents the view of a location as it appears to consumers, which includes updates that are currently serving on Google Maps and Search.", +"id": "GoogleUpdatedLocation", +"properties": { +"diffMask": { +"description": "The fields where the values in the view as it appears to consumers are different than the merchant's information. To accept these changes, patch the location. To reject, patch with your preferred values.", +"format": "google-fieldmask", +"type": "string" +}, +"location": { +"$ref": "Location", +"description": "The Google-updated version of this location." +}, +"pendingMask": { +"description": "The fields where the merchant has provided an update that is currently in flight and hasn't yet been published to Maps and Search. This mask only tracks the status of the merchant's own edits, not external changes.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"Label": { +"description": "Label to be used when displaying the price list, section, or item.", +"id": "Label", +"properties": { +"description": { +"description": "Optional. Description of the price list, section, or item.", +"type": "string" +}, +"displayName": { +"description": "Required. Display name for the price list, section, or item.", +"type": "string" +}, +"languageCode": { +"description": "Optional. The BCP-47 language code that these strings apply for. Only one set of labels may be set per language.", +"type": "string" +} +}, +"type": "object" +}, +"LatLng": { +"description": "An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this object must conform to the WGS84 standard. Values must be within normalized ranges.", +"id": "LatLng", +"properties": { +"latitude": { +"description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", +"format": "double", +"type": "number" +}, +"longitude": { +"description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"ListAttributeMetadataResponse": { +"description": "Response for AttributesService.ListAttributeMetadata.", +"id": "ListAttributeMetadataResponse", +"properties": { +"attributeMetadata": { +"description": "A collection of attribute metadata for the available attributes.", +"items": { +"$ref": "AttributeMetadata" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If the number of attributes exceeded the requested page size, this field will be populated with a token to fetch the next page of attributes on a subsequent call to `attributes.list`. If there are no more attributes, this field will not be present in the response.", +"type": "string" +} +}, +"type": "object" +}, +"ListCategoriesResponse": { +"description": "Response message for BusinessCategories.ListCategories.", +"id": "ListCategoriesResponse", +"properties": { +"categories": { +"description": "The matching categories based on the requested parameters.", +"items": { +"$ref": "Category" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If the number of categories exceeded the requested page size, this field will be populated with a token to fetch the next page of categories on a subsequent call to `ListCategories`.", +"type": "string" +} +}, +"type": "object" +}, +"ListLocationsResponse": { +"description": "Response message for Locations.ListLocations.", +"id": "ListLocationsResponse", +"properties": { +"locations": { +"description": "The locations.", +"items": { +"$ref": "Location" +}, +"type": "array" +}, +"nextPageToken": { +"description": "If the number of locations exceeded the requested page size, this field is populated with a token to fetch the next page of locations on a subsequent call to `ListLocations`. If there are no more locations, this field is not present in the response.", +"type": "string" +}, +"totalSize": { +"description": "The approximate number of Locations in the list irrespective of pagination. This field will only be returned if `filter` is used as a query parameter.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"Location": { +"description": "A location. See the [help center article] (https://support.google.com/business/answer/3038177) for a detailed description of these fields, or the [category endpoint](/my-business/reference/rest/v4/categories) for a list of valid business categories.", +"id": "Location", +"properties": { +"adWordsLocationExtensions": { +"$ref": "AdWordsLocationExtensions", +"description": "Optional. Additional information that is surfaced in AdWords." +}, +"categories": { +"$ref": "Categories", +"description": "Optional. The different categories that describe the business." +}, +"labels": { +"description": "Optional. A collection of free-form strings to allow you to tag your business. These labels are NOT user facing; only you can see them. Must be between 1-255 characters per label.", +"items": { +"type": "string" +}, +"type": "array" +}, +"languageCode": { +"description": "Immutable. The language of the location. Set during creation and not updateable.", +"type": "string" +}, +"latlng": { +"$ref": "LatLng", +"description": "Optional. User-provided latitude and longitude. When creating a location, this field is ignored if the provided address geocodes successfully. This field is only returned on get requests if the user-provided `latlng` value was accepted during create, or the `latlng` value was updated through the Google Business Profile website. This field can only be updated by approved clients." +}, +"metadata": { +"$ref": "Metadata", +"description": "Output only. Additional non-user-editable information.", +"readOnly": true +}, +"moreHours": { +"description": "Optional. More hours for a business's different departments or specific customers.", +"items": { +"$ref": "MoreHours" +}, +"type": "array" +}, +"name": { +"description": "Identifier. Google identifier for this location in the form: `locations/{location_id}`.", +"type": "string" +}, +"openInfo": { +"$ref": "OpenInfo", +"description": "Optional. A flag that indicates whether the location is currently open for business." +}, +"phoneNumbers": { +"$ref": "PhoneNumbers", +"description": "Optional. The different phone numbers that customers can use to get in touch with the business." +}, +"profile": { +"$ref": "Profile", +"description": "Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g., hotels, motels, inns)." +}, +"regularHours": { +"$ref": "BusinessHours", +"description": "Optional. Operating hours for the business." +}, +"relationshipData": { +"$ref": "RelationshipData", +"description": "Optional. All locations and chain related to this one." +}, +"serviceArea": { +"$ref": "ServiceAreaBusiness", +"description": "Optional. Service area businesses provide their service at the customer's location. If this business is a service area business, this field describes the area(s) serviced by the business." +}, +"serviceItems": { +"description": "Optional. List of services supported by merchants. A service can be haircut, install water heater, etc. Duplicated service items will be removed automatically.", +"items": { +"$ref": "ServiceItem" +}, +"type": "array" +}, +"specialHours": { +"$ref": "SpecialHours", +"description": "Optional. Special hours for the business. This typically includes holiday hours, and other times outside of regular operating hours. These override regular business hours. This field cannot be set without regular hours." +}, +"storeCode": { +"description": "Optional. External identifier for this location, which must be unique within a given account. This is a means of associating the location with your own records.", +"type": "string" +}, +"storefrontAddress": { +"$ref": "PostalAddress", +"description": "Optional. A precise, accurate address to describe your business location. PO boxes or mailboxes located at remote locations are not acceptable. At this time, you can specify a maximum of five `address_lines` values in the address. This field should only be set for businesses that have a storefront. This field should not be set for locations of type `CUSTOMER_LOCATION_ONLY` but if set, any value provided will be discarded." +}, +"title": { +"description": "Required. Location name should reflect your business's real-world name, as used consistently on your storefront, website, and stationery, and as known to customers. Any additional information, when relevant, can be included in other fields of the resource (for example, `Address`, `Categories`). Don't add unnecessary information to your name (for example, prefer \"Google\" over \"Google Inc. - Mountain View Corporate Headquarters\"). Don't include marketing taglines, store codes, special characters, hours or closed/open status, phone numbers, website URLs, service/product information, location/address or directions, or containment information (for example, \"Chase ATM in Duane Reade\").", +"type": "string" +}, +"websiteUri": { +"description": "Optional. A URL for this business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.", +"type": "string" +} +}, +"type": "object" +}, +"Metadata": { +"description": "Additional non-user-editable information about the location.", +"id": "Metadata", +"properties": { +"canDelete": { +"description": "Output only. Indicates whether the location can be deleted using the API.", +"readOnly": true, +"type": "boolean" +}, +"canHaveBusinessCalls": { +"deprecated": true, +"description": "Output only. Deprecated: Relates to the Call Tracking feature which is no longer supported. Indicates whether the location is eligible for business calls.", +"readOnly": true, +"type": "boolean" +}, +"canHaveFoodMenus": { +"description": "Output only. Indicates if the listing is eligible for food menu.", +"readOnly": true, +"type": "boolean" +}, +"canModifyServiceList": { +"description": "Output only. Indicates if the listing can modify the service list.", +"readOnly": true, +"type": "boolean" +}, +"canOperateHealthData": { +"description": "Output only. Indicates whether the location can operate on Health data.", +"readOnly": true, +"type": "boolean" +}, +"canOperateLocalPost": { +"deprecated": true, +"description": "Output only. Deprecated: This field is no longer populated and will be removed in a future version.", +"readOnly": true, +"type": "boolean" +}, +"canOperateLodgingData": { +"description": "Output only. Indicates whether the location can operate on Lodging data.", +"readOnly": true, +"type": "boolean" +}, +"duplicateLocation": { +"description": "Output only. The location resource that this location duplicates.", +"readOnly": true, +"type": "string" +}, +"hasGoogleUpdated": { +"description": "Output only. Indicates whether the place ID associated with this location has updates that need to be updated or rejected by the client. If this boolean is set, you should call the `getGoogleUpdated` method to look up information that's needs to be verified.", +"readOnly": true, +"type": "boolean" +}, +"hasPendingEdits": { +"description": "Output only. Indicates whether any of this Location's properties are in the edit pending state.", +"readOnly": true, +"type": "boolean" +}, +"hasVoiceOfMerchant": { +"description": "Output only. Indicates if the listing has Voice of Merchant. If this boolean is false, you should call the locations.getVoiceOfMerchantState API to get details as to why they do not have Voice of Merchant.", +"readOnly": true, +"type": "boolean" +}, +"isParticularlyPersonalPlace": { +"description": "Output only. Indicates whether the location is classified as a particularly personal place. This means there are restrictions on Location History features. If you believe this was a mistake, see the [help center article](https://support.google.com/business/answer/3480441).", +"readOnly": true, +"type": "boolean" +}, +"mapsUri": { +"description": "Output only. A link to the location on Maps.", +"readOnly": true, +"type": "string" +}, +"newReviewUri": { +"description": "Output only. A link to the page on Google Search where a customer can leave a review for the location.", +"readOnly": true, +"type": "string" +}, +"placeId": { +"description": "Output only. If this location appears on Google Maps, this field is populated with the place ID for the location. This ID can be used in various Places APIs. This field can be set during Create calls, but not for Update.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "Number of nano (10^-9) units of the amount. 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.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"MoreHours": { +"description": "The time periods during which a location is open for certain types of business.", +"id": "MoreHours", +"properties": { +"hoursTypeId": { +"description": "Required. Type of hours. Clients should call {#link businessCategories:BatchGet} to get supported hours types for categories of their locations.", +"type": "string" +}, +"periods": { +"description": "Required. A collection of times that this location is open. Each period represents a range of hours when the location is open during the week.", +"items": { +"$ref": "TimePeriod" +}, +"type": "array" +} +}, +"type": "object" +}, +"MoreHoursType": { +"description": "More hours types that a business can offers, in addition to its regular hours.", +"id": "MoreHoursType", +"properties": { +"displayName": { +"description": "Output only. The human-readable English display name for the hours type.", +"readOnly": true, +"type": "string" +}, +"hoursTypeId": { +"description": "Output only. A stable ID provided by Google for this hours type.", +"readOnly": true, +"type": "string" +}, +"localizedDisplayName": { +"description": "Output only. The human-readable localized display name for the hours type.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"OpenInfo": { +"description": "Information related to the opening state of the business.", +"id": "OpenInfo", +"properties": { +"canReopen": { +"description": "Output only. Indicates whether this business is eligible for re-open.", +"readOnly": true, +"type": "boolean" +}, +"openingDate": { +"$ref": "Date", +"description": "Optional. The date on which the location first opened. If the exact day is not known, month and year only can be provided. The date must be in the past or be no more than one year in the future." +}, +"status": { +"description": "Required. Indicates whether or not the Location is currently open for business. All locations are open by default, unless updated to be closed.", +"enum": [ +"OPEN_FOR_BUSINESS_UNSPECIFIED", +"OPEN", +"CLOSED_PERMANENTLY", +"CLOSED_TEMPORARILY" +], +"enumDescriptions": [ +"Not specified.", +"Indicates that the location is open.", +"Indicates that the location has been permanently closed.", +"Indicates that the location has been temporarily closed." +], +"type": "string" +} +}, +"type": "object" +}, +"PhoneNumbers": { +"description": "A collection of phone numbers for the business. During updates, both fields must be set. Clients may not update just the primary or additional phone numbers using the update mask. International phone format is preferred, such as \"+1 415 555 0132\", see more in (https://developers.google.com/style/phone-numbers#international-phone-numbers).", +"id": "PhoneNumbers", +"properties": { +"additionalPhones": { +"description": "Optional. Up to two phone numbers (mobile or landline, no fax) at which your business can be called, in addition to your primary phone number.", +"items": { +"type": "string" +}, +"type": "array" +}, +"primaryPhone": { +"description": "Required. A phone number that connects to your individual business location as directly as possible. Use a local phone number instead of a central, call center helpline number whenever possible.", +"type": "string" +} +}, +"type": "object" +}, +"PlaceInfo": { +"description": "Defines an area that's represented by a place ID.", +"id": "PlaceInfo", +"properties": { +"placeId": { +"description": "Required. The ID of the place. Must correspond to a region. (https://developers.google.com/places/web-service/supported_types#table3)", +"type": "string" +}, +"placeName": { +"description": "Required. The localized name of the place. For example, `Scottsdale, AZ`.", +"type": "string" +} +}, +"type": "object" +}, +"Places": { +"description": "Defines the union of areas represented by a set of places.", +"id": "Places", +"properties": { +"placeInfos": { +"description": "Optional. The areas represented by place IDs. Limited to a maximum of 20 places.", +"items": { +"$ref": "PlaceInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"PostalAddress": { +"description": "Represents a postal address, such as for postal delivery or payments addresses. With a postal address, a postal service can deliver items to a premise, P.O. box, or similar. A postal address is not intended to model geographical locations like roads, towns, or mountains. In typical usage, an address would be created by user input or from importing existing data, depending on the type of process. Advice on address input or editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput. - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, see: https://support.google.com/business/answer/6397478.", +"id": "PostalAddress", +"properties": { +"addressLines": { +"description": "Unstructured address lines describing the lower levels of an address. Because values in `address_lines` do not have type information and may sometimes contain multiple values in a single field (for example, \"Austin, TX\"), it is important that the line order is clear. The order of address lines should be \"envelope order\" for the country or region of the address. In places where this can vary (for example, Japan), `address_language` is used to make it explicit (for example, \"ja\" for large-to-small ordering and \"ja-Latn\" or \"en\" for small-to-large). In this way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a `region_code` with all remaining information placed in the `address_lines`. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a `region_code` and `address_lines` and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).", +"items": { +"type": "string" +}, +"type": "array" +}, +"administrativeArea": { +"description": "Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, \"Barcelona\" and not \"Catalonia\"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.", +"type": "string" +}, +"languageCode": { +"description": "Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: \"zh-Hant\", \"ja\", \"ja-Latn\", \"en\".", +"type": "string" +}, +"locality": { +"description": "Optional. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave `locality` empty and use `address_lines`.", +"type": "string" +}, +"organization": { +"description": "Optional. The name of the organization at the address.", +"type": "string" +}, +"postalCode": { +"description": "Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).", +"type": "string" +}, +"recipients": { +"description": "Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain \"care of\" information.", +"items": { +"type": "string" +}, +"type": "array" +}, +"regionCode": { +"description": "Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland.", +"type": "string" +}, +"revision": { +"description": "The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.", +"format": "int32", +"type": "integer" +}, +"sortingCode": { +"description": "Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like \"CEDEX\", optionally followed by a number (for example, \"CEDEX 7\"), or just a number alone, representing the \"sector code\" (Jamaica), \"delivery area indicator\" (Malawi) or \"post office indicator\" (C\u00f4te d'Ivoire).", +"type": "string" +}, +"sublocality": { +"description": "Optional. Sublocality of the address. For example, this can be a neighborhood, borough, or district.", +"type": "string" +} +}, +"type": "object" +}, +"Profile": { +"description": "All information pertaining to the location's profile.", +"id": "Profile", +"properties": { +"description": { +"description": "Required. Description of the location in your own voice, not editable by anyone else.", +"type": "string" +} +}, +"type": "object" +}, +"RelationshipData": { +"description": "Information of all parent and children locations related to this one.", +"id": "RelationshipData", +"properties": { +"childrenLocations": { +"description": "Optional. The list of children locations that this location has relations with.", +"items": { +"$ref": "RelevantLocation" +}, +"type": "array" +}, +"parentChain": { +"description": "Optional. The resource name of the Chain that this location is member of. How to find Chain ID", +"type": "string" +}, +"parentLocation": { +"$ref": "RelevantLocation", +"description": "Optional. The parent location that this location has relations with." +} +}, +"type": "object" +}, +"RelevantLocation": { +"description": "Information about another location that is related to current one. The relation can be any one of DEPARTMENT_OF or INDEPENDENT_ESTABLISHMENT_OF, and the location specified here can be on either side (parent/child) of the location.", +"id": "RelevantLocation", +"properties": { +"placeId": { +"description": "Required. Specify the location that is on the other side of the relation by its placeID.", +"type": "string" +}, +"relationType": { +"description": "Required. The type of the relationship.", +"enum": [ +"RELATION_TYPE_UNSPECIFIED", +"DEPARTMENT_OF", +"INDEPENDENT_ESTABLISHMENT_IN" +], +"enumDescriptions": [ +"Type unspecified.", +"This represents a relation between 2 locations which share one physical area, same brand/upper management/organization, but with different key attributes like store hours or phone numbers. For example, Costco Pharmacy is a department in Costco Wholesale.", +"This represents the cases where 2 locations are co-located in the same physical location, but from different companies (e.g., Starbucks in a Safeway, shops in a mall)." +], +"type": "string" +} +}, +"type": "object" +}, +"RepeatedEnumAttributeValue": { +"description": "Values for an attribute with a `value_type` of REPEATED_ENUM. This consists of two lists of value IDs: those that are set (true) and those that are unset (false). Values absent are considered unknown. At least one value must be specified.", +"id": "RepeatedEnumAttributeValue", +"properties": { +"setValues": { +"description": "Enum values that are set.", +"items": { +"type": "string" +}, +"type": "array" +}, +"unsetValues": { +"description": "Enum values that are unset.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"SearchChainsResponse": { +"description": "Response message for Locations.SearchChains.", +"id": "SearchChainsResponse", +"properties": { +"chains": { +"description": "Chains that match the queried chain_display_name in SearchChainsRequest. If there are no matches, this field will be empty. Results are listed in order of relevance.", +"items": { +"$ref": "Chain" +}, +"type": "array" +} +}, +"type": "object" +}, +"SearchGoogleLocationsRequest": { +"description": "Request message for GoogleLocations.SearchGoogleLocations.", +"id": "SearchGoogleLocationsRequest", +"properties": { +"location": { +"$ref": "Location", +"description": "Location to search for. If provided, will find locations which match the provided location details, which must include a value for the title." +}, +"pageSize": { +"description": "The number of matches to return. The default value is 3, with a maximum of 10. Note that latency may increase if more are requested. There is no pagination.", +"format": "int32", +"type": "integer" +}, +"query": { +"description": "Text query to search for. The search results from a query string will be less accurate than if providing an exact location, but can provide more inexact matches.", +"type": "string" +} +}, +"type": "object" +}, +"SearchGoogleLocationsResponse": { +"description": "Response message for GoogleLocations.SearchGoogleLocations.", +"id": "SearchGoogleLocationsResponse", +"properties": { +"googleLocations": { +"description": "A collection of GoogleLocations that are potential matches to the specified request, listed in order from most to least accuracy.", +"items": { +"$ref": "GoogleLocation" +}, +"type": "array" +} +}, +"type": "object" +}, +"ServiceAreaBusiness": { +"description": "Service area businesses provide their service at the customer's location (for example, a locksmith or plumber).", +"id": "ServiceAreaBusiness", +"properties": { +"businessType": { +"description": "Required. Indicates the type of the service area business.", +"enum": [ +"BUSINESS_TYPE_UNSPECIFIED", +"CUSTOMER_LOCATION_ONLY", +"CUSTOMER_AND_BUSINESS_LOCATION" +], +"enumDescriptions": [ +"Output only. Not specified.", +"Offers service only in the surrounding area (not at the business address). If a business is being updated from a CUSTOMER_AND_BUSINESS_LOCATION to a CUSTOMER_LOCATION_ONLY, the location update must include field mask `storefront_address` and set the field to empty.", +"Offers service at the business address and the surrounding area." +], +"type": "string" +}, +"places": { +"$ref": "Places", +"description": "Optional. The area that this business serves defined through a set of places." +}, +"regionCode": { +"description": "Immutable. CLDR region code of the country/region that this service area business is based in. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: \"CH\" for Switzerland. This field is required for CUSTOMER_LOCATION_ONLY businesses, and is ignored otherwise. The region specified here can be different from regions for the areas that this business serves (e.g. service area businesses that provide services in regions other than the one that they are based in). If this location requires verification after creation, the address provided for verification purposes *must* be located within this region, and the business owner or their authorized representative *must* be able to receive postal mail at the provided verification address.", +"type": "string" +} +}, +"type": "object" +}, +"ServiceItem": { +"description": "A message that describes a single service item. It is used to describe the type of service that the merchant provides. For example, haircut can be a service.", +"id": "ServiceItem", +"properties": { +"freeFormServiceItem": { +"$ref": "FreeFormServiceItem", +"description": "Optional. This field will be set case of free-form services data." +}, +"price": { +"$ref": "Money", +"description": "Optional. Represents the monetary price of the service item. We recommend that currency_code and units should be set when including a price. This will be treated as a fixed price for the service item." +}, +"structuredServiceItem": { +"$ref": "StructuredServiceItem", +"description": "Optional. This field will be set case of structured services data." +} +}, +"type": "object" +}, +"ServiceType": { +"description": "A message describing a service type that the business offers.", +"id": "ServiceType", +"properties": { +"displayName": { +"description": "Output only. The human-readable display name for the service type.", +"readOnly": true, +"type": "string" +}, +"serviceTypeId": { +"description": "Output only. A stable ID (provided by Google) for this service type.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"SpecialHourPeriod": { +"description": "Represents a single time period when a location's operational hours differ from its normal business hours. A special hour period must represent a range of less than 24 hours. The `open_time` and `start_date` must predate the `close_time` and `end_date`. The `close_time` and `end_date` can extend to 11:59 a.m. on the day after the specified `start_date`. For example, the following inputs are valid: start_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-23, open_time=08:00, close_time=18:00 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=11:59 The following inputs are not valid: start_date=2015-11-23, open_time=13:00, close_time=11:59 start_date=2015-11-23, end_date=2015-11-24, open_time=13:00, close_time=12:00 start_date=2015-11-23, end_date=2015-11-25, open_time=08:00, close_time=18:00", +"id": "SpecialHourPeriod", +"properties": { +"closeTime": { +"$ref": "TimeOfDay", +"description": "Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false." +}, +"closed": { +"description": "Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.", +"type": "boolean" +}, +"endDate": { +"$ref": "Date", +"description": "Optional. The calendar date this special hour period ends on. If `end_date` field is not set, default to the date specified in `start_date`. If set, this field must be equal to or at most 1 day after `start_date`." +}, +"openTime": { +"$ref": "TimeOfDay", +"description": "Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false." +}, +"startDate": { +"$ref": "Date", +"description": "Required. The calendar date this special hour period starts on." +} +}, +"type": "object" +}, +"SpecialHours": { +"description": "Represents a set of time periods when a location's operational hours differ from its normal business hours.", +"id": "SpecialHours", +"properties": { +"specialHourPeriods": { +"description": "Required. A list of exceptions to the business's regular hours.", +"items": { +"$ref": "SpecialHourPeriod" +}, +"type": "array" +} +}, +"type": "object" +}, +"StructuredServiceItem": { +"description": "Represents a structured service offered by the merchant. For eg: toilet_installation.", +"id": "StructuredServiceItem", +"properties": { +"description": { +"description": "Optional. Description of structured service item. The character limit is 300.", +"type": "string" +}, +"serviceTypeId": { +"description": "Required. The `service_type_id` field is a Google provided unique ID that can be found in `ServiceType`. This information is provided by `BatchGetCategories` rpc service.", +"type": "string" +} +}, +"type": "object" +}, +"TimeOfDay": { +"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimePeriod": { +"description": "Represents a span of time that the business is open, starting on the specified open day/time and closing on the specified close day/time. The closing time must occur after the opening time, for example later in the same day, or on a subsequent day.", +"id": "TimePeriod", +"properties": { +"closeDay": { +"description": "Required. Indicates the day of the week this period ends on.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"closeTime": { +"$ref": "TimeOfDay", +"description": "Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time." +}, +"openDay": { +"description": "Required. Indicates the day of the week this period starts on.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"openTime": { +"$ref": "TimeOfDay", +"description": "Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time." +} +}, +"type": "object" +}, +"UriAttributeValue": { +"description": "Values for an attribute with a `value_type` of URL.", +"id": "UriAttributeValue", +"properties": { +"uri": { +"description": "Required. The proposed URI value for this attribute.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "My Business Business Information API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index ee1bdc0ec2..5b54576958 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -224,7 +224,7 @@ "type": "string" }, "updateMask": { -"description": "Required. The specific fields to update. The only editable fields are `uri`, `place_action_type` and `is_preferred`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error.", +"description": "Required. The specific fields to update. The only editable fields are `uri`, `place_action_type`, `is_preferred` and `is_disabled`. If the updated link already exists at the same location with the same `place_action_type` and `uri`, fails with an `ALREADY_EXISTS` error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -281,7 +281,7 @@ } } }, -"revision": "20261026", +"revision": "20261111", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { @@ -336,6 +336,10 @@ "readOnly": true, "type": "string" }, +"isDisabled": { +"description": "Optional. Whether the merchant disabled this link. Defaults to `false`, which means the link is enabled. If `provider_type` is `AGGREGATOR_3P`, the merchant can disable or enable this link through `UpdatePlaceActionLink`. If `provider_type` is `MERCHANT`, this field is always `false` and `UpdatePlaceActionLink` rejects updates to it.", +"type": "boolean" +}, "isEditable": { "description": "Output only. Indicates whether this link can be edited by the client.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index 90dccaba84..98a9eb34b1 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -256,7 +256,7 @@ } } }, -"revision": "20260527", +"revision": "20261110", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { @@ -375,7 +375,7 @@ "id": "GenerateInstantVerificationTokenRequest", "properties": { "locationId": { -"description": "The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Google My Business API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](/my-business/reference/rest/v4/accounts.locations) documentation for more information.", +"description": "The location identifier associated with an unverified listing. This is the location id generated at the time that the listing was originally created. It is the final portion of a location resource name as generated by the Business Information API. Note: the caller must be an owner or manager of this listing in order to generate a verification token. See the [location resource](https://developers.google.com/my-business/reference/businessinformation/rest/v1/accounts.locations) documentation for more information.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index aaf913bb73..43e8cc9b38 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1183,7 +1183,7 @@ "type": "string" }, "cloudDeploymentType": { -"description": "Optional. The deployment type for Cloud Monitoring Points.", +"description": "Optional. Specifies the deployment type for Cloud Monitoring Points. Supported values: `TERRAFORM` for `GCE_VM`; `BICEP` or `TERRAFORM` for `AZURE_VM`; and `CLOUD_FORMATION` or `TERRAFORM` for `AWS_EC2`. If unspecified, defaults to `TERRAFORM`, `BICEP`, and `CLOUD_FORMATION`, respectively. Leave it unspecified for other types.", "enum": [ "CLOUD_DEPLOYMENT_TYPE_UNSPECIFIED", "TERRAFORM", @@ -1192,8 +1192,8 @@ ], "enumDescriptions": [ "Default value. If unspecified, defaults to `TERRAFORM` for `GCE_VM`, `BICEP` for `AZURE_VM`, and `CLOUD_FORMATION` for `AWS_EC2`.", -"Deploys using Terraform.", -"Deploys using AWS Cloud Formation. Supported only for `AWS_EC2` deployments.", +"Deploys using Terraform. Supported only for `GCE_VM`, `AZURE_VM`, and `AWS_EC2` deployments.", +"Deploys using AWS CloudFormation. Supported only for `AWS_EC2` deployments.", "Deploys using Azure Bicep. Supported only for `AZURE_VM` deployments." ], "location": "query", @@ -1814,7 +1814,7 @@ } } }, -"revision": "20261028", +"revision": "20261110", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1987,7 +1987,7 @@ false "type": "array" }, "resourceUri": { -"description": "URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance)", +"description": "URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance)", "type": "string" } }, @@ -2021,7 +2021,7 @@ false "type": "string" }, "uri": { -"description": "URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}`", +"description": "URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}`", "type": "string" } }, @@ -2127,7 +2127,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}`", +"description": "URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}`", "type": "string" }, "versionId": { @@ -2151,7 +2151,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}`", +"description": "URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}`", "type": "string" } }, @@ -2190,15 +2190,15 @@ false "type": "string" }, "serviceUri": { -"description": "URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`.", +"description": "URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`.", "type": "string" }, "uri": { -"description": "URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}`", +"description": "URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}`", "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}/locations/{location}/workerPools/{worker_pool}` Mutually exclusive with `service_uri`.", "type": "string" } }, @@ -2416,7 +2416,7 @@ false "id": "DirectVpcEgressConnectionInfo", "properties": { "networkUri": { -"description": "URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -2432,7 +2432,7 @@ false "type": "string" }, "subnetworkUri": { -"description": "URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -2687,7 +2687,7 @@ false "type": "string" }, "resourceUri": { -"description": "URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route)", +"description": "URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route)", "type": "string" }, "sourceGeolocationCode": { @@ -3023,7 +3023,7 @@ false "type": "string" }, "destinationNetworkUri": { -"description": "URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "destinationPort": { @@ -3044,7 +3044,7 @@ false "type": "string" }, "sourceNetworkUri": { -"description": "URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "sourcePort": { @@ -3140,7 +3140,7 @@ false "type": "integer" }, "policyUri": { -"description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy)", +"description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}` (regional network firewall policy)", "type": "string" }, "priority": { @@ -3177,7 +3177,7 @@ false "type": "string" }, "uri": { -"description": "The URI of the firewall rule in format \"projects/{project}/global/firewalls/{firewall}\". This field is not applicable to implied VPC firewall rules.", +"description": "The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules.", "type": "string" } }, @@ -3192,7 +3192,7 @@ false "type": "string" }, "resourceUri": { -"description": "URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway)", +"description": "URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway)", "type": "string" }, "target": { @@ -3316,11 +3316,11 @@ false "id": "GKEMasterInfo", "properties": { "clusterNetworkUri": { -"description": "URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "clusterUri": { -"description": "URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster)", +"description": "URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster)", "type": "string" }, "dnsEndpoint": { @@ -3438,7 +3438,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "podUri": { @@ -3568,7 +3568,7 @@ false "type": "string" }, "uri": { -"description": "URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -3645,7 +3645,7 @@ false "id": "InterconnectAttachmentInfo", "properties": { "cloudRouterUri": { -"description": "URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", +"description": "URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}`", "type": "string" }, "displayName": { @@ -3653,7 +3653,7 @@ false "type": "string" }, "interconnectUri": { -"description": "URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}`", +"description": "URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}`", "type": "string" }, "l2AttachmentMatchedIpAddress": { @@ -3683,7 +3683,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}`", +"description": "URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}`", "type": "string" } }, @@ -3957,7 +3957,7 @@ false "type": "string" }, "uri": { -"description": "URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG)", +"description": "URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG)", "type": "string" } }, @@ -3995,7 +3995,7 @@ false "type": "string" }, "healthCheckUri": { -"description": "URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy)", +"description": "URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy)", "type": "string" }, "instanceGroupUri": { @@ -4011,7 +4011,7 @@ false "type": "string" }, "networkEndpointGroupUri": { -"description": "URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG)", +"description": "URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG)", "type": "string" }, "pscGoogleApiTarget": { @@ -4046,7 +4046,7 @@ false "type": "string" }, "backendUri": { -"description": "URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}`", +"description": "URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}`", "type": "string" }, "backends": { @@ -4309,7 +4309,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "newDestinationIp": { @@ -4353,7 +4353,7 @@ false "type": "string" }, "routerUri": { -"description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", +"description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}`", "type": "string" }, "ruleNumber": { @@ -4649,7 +4649,7 @@ false "id": "NgfwPacketInspectionInfo", "properties": { "securityProfileGroupUri": { -"description": "URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}`", +"description": "URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}`", "type": "string" } }, @@ -4763,7 +4763,7 @@ false "id": "PrivateConnectionInfo", "properties": { "uri": { -"description": "URI of the Private Connection in format \"projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}\"", +"description": "URI of the Private Connection in format \"projects/{project}/locations/{location}/privateConnections/{private_connection}\"", "type": "string" } }, @@ -4895,7 +4895,7 @@ false "id": "ProxyConnectionInfo", "properties": { "networkUri": { -"description": "URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "newDestinationIp": { @@ -4939,7 +4939,7 @@ false "type": "string" }, "subnetUri": { -"description": "URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -5028,7 +5028,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project_id}/global/networks/{network_id}\".", +"description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project}/global/networks/{network}\".", "type": "string" }, "secondaryEndpointIpAddress": { @@ -5036,7 +5036,7 @@ false "type": "string" }, "uri": { -"description": "URI of a Redis Cluster in format \"projects/{project_id}/locations/{location}/clusters/{cluster_id}\"", +"description": "URI of a Redis Cluster in format \"projects/{project}/locations/{location}/clusters/{cluster}\"", "type": "string" } }, @@ -5115,7 +5115,7 @@ false "type": "array" }, "nccHubRouteUri": { -"description": "For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}`", +"description": "For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}`", "type": "string" }, "nccHubUri": { @@ -5184,7 +5184,7 @@ false "type": "string" }, "originatingRouteUri": { -"description": "For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}`", +"description": "For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}`", "type": "string" }, "priority": { @@ -5256,7 +5256,7 @@ false "type": "array" }, "uri": { -"description": "URI of a route in format \"projects/{project}/global/routes/{route}\". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.", +"description": "For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format \"projects/{project}/global/routes/{route}\". For POLICY_BASED routes URI of a route in format \"projects/{project}/locations/{location}/policyBasedRoutes/{route}\". Not set for other route types.", "type": "string" } }, @@ -5837,7 +5837,7 @@ false "type": "string" }, "uri": { -"description": "URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}`", +"description": "URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}`", "type": "string" } }, @@ -6017,7 +6017,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -6025,11 +6025,11 @@ false "type": "string" }, "uri": { -"description": "URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway)", +"description": "URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway)", "type": "string" }, "vpnTunnelUri": { -"description": "URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}`", +"description": "URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}`", "type": "string" } }, @@ -6044,7 +6044,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -6052,7 +6052,7 @@ false "type": "string" }, "remoteGateway": { -"description": "URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway)", +"description": "URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway)", "type": "string" }, "remoteGatewayIp": { @@ -6076,7 +6076,7 @@ false "type": "string" }, "sourceGateway": { -"description": "URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway)", +"description": "URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway)", "type": "string" }, "sourceGatewayIp": { @@ -6084,7 +6084,7 @@ false "type": "string" }, "uri": { -"description": "URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}`", +"description": "URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 324136092a..b70c47919e 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20261014", +"revision": "20261110", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1410,7 +1410,7 @@ false "type": "array" }, "resourceUri": { -"description": "URI of the resource that caused the abort. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC network) * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (VM instance)", +"description": "URI of the resource that caused the abort. Format: * `projects/{project}/global/networks/{network}` (VPC network) * `projects/{project}/zones/{zone}/instances/{instance}` (VM instance)", "type": "string" } }, @@ -1444,7 +1444,7 @@ false "type": "string" }, "uri": { -"description": "URI of the App Engine version. Format: `apps/{app_id}/services/{service_id}/versions/{version_id}`", +"description": "URI of the App Engine version. Format: `apps/{app}/services/{service}/versions/{version}`", "type": "string" } }, @@ -1550,7 +1550,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Cloud Function. Format: `projects/{project_id}/locations/{location}/functions/{function_id}`", +"description": "URI of the Cloud Function. Format: `projects/{project}/locations/{location}/functions/{function}`", "type": "string" }, "versionId": { @@ -1574,7 +1574,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Cloud Run job. Format: `projects/{project_id}/locations/{location}/jobs/{job_id}`", +"description": "URI of the Cloud Run job. Format: `projects/{project}/locations/{location}/jobs/{job}`", "type": "string" } }, @@ -1613,15 +1613,15 @@ false "type": "string" }, "serviceUri": { -"description": "URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`.", +"description": "URI of Cloud Run service this revision belongs to. Format: `projects/{project}/locations/{location}/services/{service}` Mutually exclusive with `worker_pool_uri`.", "type": "string" }, "uri": { -"description": "URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}`", +"description": "URI of the Cloud Run revision. Format: `projects/{project}/locations/{location}/revisions/{revision}`", "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}/locations/{location}/workerPools/{worker_pool}` Mutually exclusive with `service_uri`.", "type": "string" } }, @@ -1759,7 +1759,7 @@ false "One of two services sharing IP ranges: * Load Balancer proxy * Centralized Health Check prober https://cloud.google.com/load-balancing/docs/firewall-rules", "Connectivity from Cloud DNS to forwarding targets or alternate name servers that use private routing. https://cloud.google.com/dns/docs/zones/forwarding-zones#firewall-rules https://cloud.google.com/dns/docs/policies#firewall-rules", "private.googleapis.com and restricted.googleapis.com", -"Google API via Serverless VPC Access. https://cloud.google.com/vpc/docs/serverless-vpc-access" +"Google API via Private Service Connect. https://cloud.google.com/vpc/docs/configure-private-service-connect-apis Google API via Serverless VPC Access. https://cloud.google.com/vpc/docs/serverless-vpc-access" ], "type": "string" }, @@ -1839,7 +1839,7 @@ false "id": "DirectVpcEgressConnectionInfo", "properties": { "networkUri": { -"description": "URI of the VPC network for direct egress. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network for direct egress. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -1855,7 +1855,7 @@ false "type": "string" }, "subnetworkUri": { -"description": "URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the subnetwork for direct egress. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -2110,7 +2110,7 @@ false "type": "string" }, "resourceUri": { -"description": "URI of the resource that caused the drop. Format: * `projects/{project_id}/global/firewalls/{firewall_id}` (firewall rule) * `projects/{project_id}/global/routes/{route_id}` (route)", +"description": "URI of the resource that caused the drop. Format: * `projects/{project}/global/firewalls/{firewall}` (firewall rule) * `projects/{project}/global/routes/{route}` (subnet, static or peering subnet route) * `projects/{project}/locations/{location}/policyBasedRoutes/{route}` (policy-based route)", "type": "string" }, "sourceGeolocationCode": { @@ -2446,7 +2446,7 @@ false "type": "string" }, "destinationNetworkUri": { -"description": "URI of the network where this packet is sent to. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network where this packet is sent to. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "destinationPort": { @@ -2467,7 +2467,7 @@ false "type": "string" }, "sourceNetworkUri": { -"description": "URI of the network where this packet originates from. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network where this packet originates from. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "sourcePort": { @@ -2563,7 +2563,7 @@ false "type": "integer" }, "policyUri": { -"description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy_id}` (hierarchical policy) * `projects/{project_id}/global/firewallPolicies/{policy_id}` (global network firewall policy) * `projects/{project_id}/regions/{region}/firewallPolicies/{policy_id}` (regional network firewall policy)", +"description": "The URI of the firewall policy that this rule is associated with. This field is not applicable to VPC firewall rules and implied VPC firewall rules. Format: * `locations/global/firewallPolicies/{policy}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}`", "type": "string" }, "priority": { @@ -2600,7 +2600,7 @@ false "type": "string" }, "uri": { -"description": "The URI of the firewall rule in format \"projects/{project}/global/firewalls/{firewall}\". This field is not applicable to implied VPC firewall rules.", +"description": "The URI of the firewall rule in format * `locations/global/firewallPolicies/{policy}/priority/{priority}` (hierarchical policy) * `projects/{project}/global/firewallPolicies/{policy}/priority/{priority}` (global network firewall policy) * `projects/{project}/regions/{region}/firewallPolicies/{policy}/priority/{priority}` (regional network firewall policy) * `projects/{project}/global/firewalls/{firewall}` (VPC firewall rule). This field is not applicable to implied VPC firewall rules.", "type": "string" } }, @@ -2615,7 +2615,7 @@ false "type": "string" }, "resourceUri": { -"description": "URI of the resource that the packet is forwarded to. Format: * `projects/{project_id}/global/networks/{network_id}` (VPC peering network) * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (VPN gateway)", +"description": "URI of the resource that the packet is forwarded to. Format: * `projects/{project}/global/networks/{network}` (VPC peering network) * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (VPN gateway)", "type": "string" }, "target": { @@ -2739,11 +2739,11 @@ false "id": "GKEMasterInfo", "properties": { "clusterNetworkUri": { -"description": "URI of the GKE cluster network. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the GKE cluster network. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "clusterUri": { -"description": "URI of the GKE cluster. Format: * `projects/{project_id}/locations/{location}/clusters/{cluster_id}` (regional cluster) * `projects/{project_id}/zones/{zone}/clusters/{cluster_id}` (zonal cluster)", +"description": "URI of the GKE cluster. Format: * `projects/{project}/locations/{location}/clusters/{cluster}` (regional cluster) * `projects/{project}/zones/{zone}/clusters/{cluster}` (zonal cluster)", "type": "string" }, "dnsEndpoint": { @@ -2820,7 +2820,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the network containing the GKE Pod. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the network containing the GKE Pod. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "podUri": { @@ -2878,7 +2878,7 @@ false "type": "string" }, "uri": { -"description": "URI of the hybrid subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the hybrid subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -2955,7 +2955,7 @@ false "id": "InterconnectAttachmentInfo", "properties": { "cloudRouterUri": { -"description": "URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", +"description": "URI of the Cloud Router to be used for dynamic routing. Format: `projects/{project}/regions/{region}/routers/{router}`", "type": "string" }, "displayName": { @@ -2963,7 +2963,7 @@ false "type": "string" }, "interconnectUri": { -"description": "URI of the Interconnect. Format: `projects/{project_id}/global/interconnects/{interconnect_id}`", +"description": "URI of the Interconnect. Format: `projects/{project}/global/interconnects/{interconnect}`", "type": "string" }, "l2AttachmentMatchedIpAddress": { @@ -2993,7 +2993,7 @@ false "type": "string" }, "uri": { -"description": "URI of the Interconnect attachment. Format: `projects/{project_id}/regions/{region}/interconnectAttachments/{attachment_id}`", +"description": "URI of the Interconnect attachment. Format: `projects/{project}/regions/{region}/interconnectAttachments/{attachment}`", "type": "string" } }, @@ -3195,7 +3195,7 @@ false "type": "string" }, "uri": { -"description": "URI of the backend instance or network endpoint. Format: * `projects/{project_id}/zones/{zone}/instances/{instance_id}` (instance) * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG)", +"description": "URI of the backend instance or network endpoint. Format: * `projects/{project}/zones/{zone}/instances/{instance}` (instance) * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG)", "type": "string" } }, @@ -3233,7 +3233,7 @@ false "type": "string" }, "healthCheckUri": { -"description": "URI of the health check attached to this backend (if applicable). Format: * `projects/{project_id}/global/healthChecks/{health_check_id}` * `projects/{project_id}/regions/{region}/healthChecks/{health_check_id}` * `projects/{project_id}/global/httpHealthChecks/{health_check_id}` (legacy)", +"description": "URI of the health check attached to this backend (if applicable). Format: * `projects/{project}/global/healthChecks/{health_check}` * `projects/{project}/regions/{region}/healthChecks/{health_check}` * `projects/{project}/global/httpHealthChecks/{health_check}` (legacy)", "type": "string" }, "instanceGroupUri": { @@ -3249,7 +3249,7 @@ false "type": "string" }, "networkEndpointGroupUri": { -"description": "URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project_id}/zones/{zone}/networkEndpointGroups/{neg_id}` (zonal NEG) * `projects/{project_id}/regions/{region}/networkEndpointGroups/{neg_id}` (regional NEG) * `projects/{project_id}/global/networkEndpointGroups/{neg_id}` (global NEG)", +"description": "URI of the network endpoint group this backend belongs to (if applicable) Format: * `projects/{project}/zones/{zone}/networkEndpointGroups/{neg}` (zonal NEG) * `projects/{project}/regions/{region}/networkEndpointGroups/{neg}` (regional NEG) * `projects/{project}/global/networkEndpointGroups/{neg}` (global NEG)", "type": "string" }, "pscGoogleApiTarget": { @@ -3284,7 +3284,7 @@ false "type": "string" }, "backendUri": { -"description": "URI of the backend associated with the load balancer. Format: * `projects/{project_id}/regions/{region}/backendServices/{backend_service_id}` * `projects/{project_id}/global/backendServices/{backend_service_id}` * `projects/{project_id}/regions/{region}/targetPools/{target_pool_id}` * `projects/{project_id}/zones/{zone}/targetInstances/{target_instance_id}`", +"description": "URI of the backend associated with the load balancer. Format: * `projects/{project}/regions/{region}/backendServices/{backend_service}` * `projects/{project}/global/backendServices/{backend_service}` * `projects/{project}/regions/{region}/targetPools/{target_pool}` * `projects/{project}/zones/{zone}/targetInstances/{target_instance}`", "type": "string" }, "backends": { @@ -3385,7 +3385,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where NAT translation takes place. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where NAT translation takes place. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "newDestinationIp": { @@ -3429,7 +3429,7 @@ false "type": "string" }, "routerUri": { -"description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project_id}/regions/{region}/routers/{router_id}`", +"description": "URI of the Cloud Router. Only valid when type is CLOUD_NAT. Format: `projects/{project}/regions/{region}/routers/{router}`", "type": "string" }, "ruleNumber": { @@ -3492,7 +3492,7 @@ false "id": "NgfwPacketInspectionInfo", "properties": { "securityProfileGroupUri": { -"description": "URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization_id}/locations/global/securityProfileGroups/{security_profile_group_id}`", +"description": "URI of the security profile group associated with this firewall packet inspection. Format: `organizations/{organization}/locations/global/securityProfileGroups/{security_profile_group}`", "type": "string" } }, @@ -3606,7 +3606,7 @@ false "id": "PrivateConnectionInfo", "properties": { "uri": { -"description": "URI of the Private Connection in format \"projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}\"", +"description": "URI of the Private Connection in format \"projects/{project}/locations/{location}/privateConnections/{private_connection}\"", "type": "string" } }, @@ -3698,7 +3698,7 @@ false "id": "ProxyConnectionInfo", "properties": { "networkUri": { -"description": "URI of the VPC network where connection is proxied. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where connection is proxied. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "newDestinationIp": { @@ -3742,7 +3742,7 @@ false "type": "string" }, "subnetUri": { -"description": "URI of the proxy subnet. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", +"description": "URI of the proxy subnet. Format: `projects/{project}/regions/{region}/subnetworks/{subnetwork}`", "type": "string" } }, @@ -3831,7 +3831,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project_id}/global/networks/{network_id}\".", +"description": "URI of the network containing the Redis Cluster endpoints in format \"projects/{project}/global/networks/{network}\".", "type": "string" }, "secondaryEndpointIpAddress": { @@ -3839,7 +3839,7 @@ false "type": "string" }, "uri": { -"description": "URI of a Redis Cluster in format \"projects/{project_id}/locations/{location}/clusters/{cluster_id}\"", +"description": "URI of a Redis Cluster in format \"projects/{project}/locations/{location}/clusters/{cluster}\"", "type": "string" } }, @@ -3918,7 +3918,7 @@ false "type": "array" }, "nccHubRouteUri": { -"description": "For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project_id}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}/routes/{route_id}`", +"description": "For PEERING_SUBNET and PEERING_DYNAMIC routes that are advertised by NCC Hub, the URI of the corresponding route in NCC Hub's routing table. Format: `projects/{project}/locations/global/hubs/{hub}/routeTables/{route_table}/routes/{route}`", "type": "string" }, "nccHubUri": { @@ -3987,7 +3987,7 @@ false "type": "string" }, "originatingRouteUri": { -"description": "For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project_id}/global/routes/{route_id}`", +"description": "For PEERING_SUBNET and PEERING_STATIC routes, the URI of the originating SUBNET/STATIC route. Format: `projects/{project}/global/routes/{route}`", "type": "string" }, "priority": { @@ -4059,7 +4059,7 @@ false "type": "array" }, "uri": { -"description": "URI of a route in format \"projects/{project}/global/routes/{route}\". SUBNET, STATIC, PEERING_SUBNET (only for peering network) and POLICY_BASED routes only.", +"description": "For SUBNET, STATIC and PEERING_SUBNET (only for peering network) URI of a route in format \"projects/{project}/global/routes/{route}\". For POLICY_BASED routes URI of a route in format \"projects/{project}/locations/{location}/policyBasedRoutes/{route}\". Not set for other route types.", "type": "string" } }, @@ -4640,7 +4640,7 @@ false "type": "string" }, "uri": { -"description": "URI of a VPC connector. Format: `projects/{project_id}/locations/{location}/connectors/{connector_id}`", +"description": "URI of a VPC connector. Format: `projects/{project}/locations/{location}/connectors/{connector}`", "type": "string" } }, @@ -4820,7 +4820,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where the VPN gateway is configured. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where the VPN gateway is configured. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -4828,11 +4828,11 @@ false "type": "string" }, "uri": { -"description": "URI of the VPN gateway. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway)", +"description": "URI of the VPN gateway. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway)", "type": "string" }, "vpnTunnelUri": { -"description": "URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}`", +"description": "URI of the VPN tunnel associated with the VPN gateway. There may be multiple VPN tunnels configured on a VPN gateway, and only the one relevant to the test is displayed. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}`", "type": "string" } }, @@ -4847,7 +4847,7 @@ false "type": "string" }, "networkUri": { -"description": "URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project_id}/global/networks/{network_id}`", +"description": "URI of the VPC network where the VPN tunnel is configured. Format: `projects/{project}/global/networks/{network}`", "type": "string" }, "region": { @@ -4855,7 +4855,7 @@ false "type": "string" }, "remoteGateway": { -"description": "URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (GCP HA VPN gateway) * `projects/{project_id}/global/peerVpnGateways/{peer_vpn_gateway_id}` (GCP peer VPN gateway)", +"description": "URI of a VPN gateway at remote end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (GCP HA VPN gateway) * `projects/{project}/global/peerVpnGateways/{peer_vpn_gateway}` (GCP peer VPN gateway)", "type": "string" }, "remoteGatewayIp": { @@ -4879,7 +4879,7 @@ false "type": "string" }, "sourceGateway": { -"description": "URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project_id}/regions/{region}/vpnGateways/{vpn_gateway_id}` (HA VPN gateway) * `projects/{project_id}/regions/{region}/targetVpnGateways/{target_vpn_gateway_id}` (Classic VPN gateway)", +"description": "URI of the VPN gateway at local end of the tunnel. Format: * `projects/{project}/regions/{region}/vpnGateways/{vpn_gateway}` (HA VPN gateway) * `projects/{project}/regions/{region}/targetVpnGateways/{target_vpn_gateway}` (Classic VPN gateway)", "type": "string" }, "sourceGatewayIp": { @@ -4887,7 +4887,7 @@ false "type": "string" }, "uri": { -"description": "URI of the VPN tunnel. Format: `projects/{project_id}/regions/{region}/vpnTunnels/{vpn_tunnel_id}`", +"description": "URI of the VPN tunnel. Format: `projects/{project}/regions/{region}/vpnTunnels/{vpn_tunnel}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 3ff6ea8008..d379c4b0b3 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -1246,12 +1246,12 @@ ], "parameters": { "etag": { -"description": "Optional. The etag of the ExtensionBinding to delete.", +"description": "Optional. The ETag of the `ExtensionBinding` to delete.", "location": "query", "type": "string" }, "name": { -"description": "Required. A name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", +"description": "Required. The name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionBindings/[^/]+$", "required": true, @@ -1276,7 +1276,7 @@ ], "parameters": { "name": { -"description": "Required. A name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", +"description": "Required. The name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionBindings/[^/]+$", "required": true, @@ -1307,7 +1307,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The value returned by the last `ListExtensionBindingsResponse` Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListExtensionBindingsResponse`. Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1344,7 +1344,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3207,7 +3207,7 @@ "type": "string" }, "producerExtensionId": { -"description": "Required. Short name of the `ProducerExtension` resource to be created.", +"description": "Required. The short name of the `ProducerExtension` resource to be created.", "location": "query", "type": "string" } @@ -3233,12 +3233,12 @@ ], "parameters": { "etag": { -"description": "Optional. The etag of the ProducerExtension to delete.", +"description": "Optional. The ETag of the `ProducerExtension` to delete.", "location": "query", "type": "string" }, "name": { -"description": "Required. A name of the `ProducerExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", +"description": "Required. The name of the `ProducerExtension` resource to delete. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/producerExtensions/[^/]+$", "required": true, @@ -3263,7 +3263,7 @@ ], "parameters": { "name": { -"description": "Required. A name of the `ProducerExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", +"description": "Required. The name of the `ProducerExtension` resource to get. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/producerExtensions/[^/]+$", "required": true, @@ -3294,12 +3294,12 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The value returned by the last `ListProducerExtensionsResponse` Indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListProducerExtensionsResponse`. It indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The project and location from which the `ProducerExtension` resources should be listed, specified in the format `projects/{project}/locations/{location}`.", +"description": "Required. The project and location from which the `ProducerExtension` resources should be listed, specified in this format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4046,7 +4046,7 @@ "type": "string" }, "view": { -"description": "Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157).", +"description": "Optional. Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157).", "enum": [ "WASM_PLUGIN_VIEW_UNSPECIFIED", "WASM_PLUGIN_VIEW_BASIC", @@ -4079,13 +4079,13 @@ ], "parameters": { "pageSize": { -"description": "Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", +"description": "Optional. The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", "location": "query", "type": "string" }, @@ -4236,13 +4236,13 @@ ], "parameters": { "pageSize": { -"description": "Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", +"description": "Optional. The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", "location": "query", "type": "string" }, @@ -4271,7 +4271,7 @@ } } }, -"revision": "20261027", +"revision": "20261109", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentConnectivityTemplate": { @@ -4691,7 +4691,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`.", "type": "string" }, "timeout": { @@ -5007,7 +5007,7 @@ "type": "string" }, "failOpen": { -"description": "Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored.", +"description": "Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored.", "type": "boolean" }, "labels": { @@ -5034,7 +5034,7 @@ "type": "integer" }, "producerExtension": { -"description": "Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`.", +"description": "Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`.", "type": "string" }, "producerMetadata": { @@ -5092,7 +5092,7 @@ "type": "string" }, "exact": { -"description": "Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`.", +"description": "Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`.", "type": "string" }, "ignoreCase": { @@ -5120,7 +5120,7 @@ }, "notDestination": { "$ref": "ExtensionBindingMatchConditionToDestination", -"description": "Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified." +"description": "Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified." } }, "type": "object" @@ -5134,21 +5134,21 @@ "description": "Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched." }, "hosts": { -"description": "Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request.", +"description": "Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, "type": "array" }, "paths": { -"description": "Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", +"description": "Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, "type": "array" }, "resources": { -"description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources.", +"description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, @@ -5222,7 +5222,7 @@ "id": "ExtensionChain", "properties": { "extensions": { -"description": "Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain.", +"description": "Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain.", "items": { "$ref": "ExtensionChainExtension" }, @@ -5310,7 +5310,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources.", "type": "string" }, "supportedEvents": { @@ -5331,8 +5331,8 @@ "If included in `supported_events`, the extension is called when the HTTP request body arrives.", "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", "If included in `supported_events`, the extension is called when the HTTP response body arrives.", -"If included in `supported_events`, the extension is called when the HTTP request trailers arrives.", -"If included in `supported_events`, the extension is called when the HTTP response trailers arrives." +"If included in `supported_events`, the extension is called when the HTTP request trailers arrive.", +"If included in `supported_events`, the extension is called when the HTTP response trailers arrive." ], "type": "string" }, @@ -7472,11 +7472,6 @@ "description": "Required. The resource name of the multicast consumer association that is in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastConsumerAssociations/*`.", "type": "string" }, -"multicastGroup": { -"deprecated": true, -"description": "Optional. The resource name of the multicast group created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroups/*`. This field is deprecated. Use multicast_group_range_activation instead.", -"type": "string" -}, "multicastGroupRangeActivation": { "description": "Required. The resource name of the multicast group range activation created by the admin in the same zone as this multicast group consumer activation. Use the following format: `projects/*/locations/*/multicastGroupRangeActivations/*`.", "type": "string" @@ -7675,7 +7670,7 @@ "type": "object" }, "ProducerExtension": { -"description": "`ProducerExtension` is a resource representing producer defined configuration for their service extension.", +"description": "`ProducerExtension` is a resource that represents a producer-defined configuration for its service extension.", "id": "ProducerExtension", "properties": { "createTime": { @@ -7689,7 +7684,7 @@ "type": "string" }, "etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", +"description": "Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error.", "type": "string" }, "extensionSettings": { @@ -7708,7 +7703,7 @@ "type": "string" }, "phase": { -"description": "Required. The phase in which this `ProducerExtension` should execute.", +"description": "Required. The phase in which this `ProducerExtension` runs.", "enum": [ "PHASE_UNSPECIFIED", "TRAFFIC", @@ -7716,7 +7711,7 @@ ], "enumDescriptions": [ "Unspecified phase.", -"The `ProducerExtension` will be executed during the traffic phase.", +"Not supported.", "The `ProducerExtension` will be executed during the authorization phase." ], "type": "string" @@ -7743,7 +7738,7 @@ "type": "boolean" }, "service": { -"description": "Required. URI of the PSC attachment.", +"description": "Required. The URI of the Private Service Connect (PSC) attachment.", "type": "string" }, "supportedEvents": { @@ -7764,8 +7759,8 @@ "If included in `supported_events`, the extension is called when the HTTP request body arrives.", "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", "If included in `supported_events`, the extension is called when the HTTP response body arrives.", -"If included in `supported_events`, the extension is called when the HTTP request trailers arrives.", -"If included in `supported_events`, the extension is called when the HTTP response trailers arrives." +"If included in `supported_events`, the extension is called when the HTTP request trailers arrive.", +"If included in `supported_events`, the extension is called when the HTTP response trailers arrive." ], "type": "string" }, @@ -8321,6 +8316,15 @@ "description": "Optional. A human-readable description of the resource.", "type": "string" }, +"kmsKeyName": { +"description": "Optional. The name of the customer-managed [CryptoKey](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys) to be used to encrypt the `WasmPlugin` image (provided by image_uri) and configuration (provided by plugin_config_data or plugin_config_uri) that are stored by the `Service Extensions` product at rest. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}` By default, Google Cloud automatically encrypts all data at rest using Google-owned and Google-managed encryption keys. If you need ownership and control of the keys that protect your data at rest, you can specify a customer-managed encryption key (CMEK) to encrypt your `WasmPlugin` data. For more information, see [Using customer-managed encryption keys](https://cloud.google.com/service-extensions/docs/cmek).", +"type": "string" +}, +"kmsKeyVersion": { +"description": "Output only. The name of the specific [CryptoKeyVersion](https://cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions) used to encrypt the `WasmPlugin` data, if the kms_key_name field is set. Format: `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}/cryptoKeyVersions/{version}` This is a read-only field. `WasmPlugin` data is automatically encrypted using the most recent `CryptoKeyVersion` of the `CryptoKey` provided in the `kms_key_name` field. See [Cloud KMS resources](https://cloud.google.com/kms/docs/resource-hierarchy) for more information.", +"readOnly": true, +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 72aa7f1b04..ffe08575f1 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -790,7 +790,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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 ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`).", "location": "query", "type": "string" } @@ -823,7 +823,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`).", "location": "query", "type": "string" } @@ -846,7 +846,7 @@ ], "parameters": { "name": { -"description": "Required. A name of the `CdnEdgeExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}`.", +"description": "Required. The name of the `CdnEdgeExtension` resource to get. It must be in the `projects/{project}/locations/{location}/cdnEdgeExtensions/{cdn_edge_extension}` format.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/cdnEdgeExtensions/[^/]+$", "required": true, @@ -862,7 +862,7 @@ ] }, "list": { -"description": "Lists `CdnEdgeExtensions` resources in a given project and location.", +"description": "Lists `CdnEdgeExtension` resources in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/cdnEdgeExtensions", "httpMethod": "GET", "id": "networkservices.projects.locations.cdnEdgeExtensions.list", @@ -871,12 +871,12 @@ ], "parameters": { "filter": { -"description": "Optional. Filtering results.", +"description": "Optional. Specifies a filter expression that restricts the resources listed in the response. The expression must be of the form ` `, where `` is a field name (in `snake_case` or `camelCase`) and `` is one of `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:` (the `HAS` operator). Multiple expressions can be combined using `AND`, `OR`, and `NOT`. For example, `extension_chains.name = \"my-chain\"` or `labels.env = \"prod\"`.", "location": "query", "type": "string" }, "orderBy": { -"description": "Optional. Hint about how to order the results.", +"description": "Optional. Comma-separated list of fields by which you can sort the results.", "location": "query", "type": "string" }, @@ -924,7 +924,7 @@ "type": "string" }, "requestId": { -"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for 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 ignores the second request This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"description": "Optional. An ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees this behavior for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that the zero UUID isn't supported (`00000000-0000-0000-0000-000000000000`).", "location": "query", "type": "string" }, @@ -1347,12 +1347,12 @@ ], "parameters": { "etag": { -"description": "Optional. The etag of the ExtensionBinding to delete.", +"description": "Optional. The ETag of the `ExtensionBinding` to delete.", "location": "query", "type": "string" }, "name": { -"description": "Required. A name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", +"description": "Required. The name of the `ExtensionBinding` resource to delete. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionBindings/[^/]+$", "required": true, @@ -1377,7 +1377,7 @@ ], "parameters": { "name": { -"description": "Required. A name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", +"description": "Required. The name of the `ExtensionBinding` resource to get. Must be in the format `projects/{project}/locations/{location}/extensionBindings/{extension_binding}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/extensionBindings/[^/]+$", "required": true, @@ -1408,7 +1408,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The value returned by the last `ListExtensionBindingsResponse` Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListExtensionBindingsResponse`. Indicates that this is a continuation of a prior `ListExtensionBindings` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, @@ -1445,7 +1445,7 @@ "type": "string" }, "updateMask": { -"description": "Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Optional. Field mask is used to specify the fields to be overwritten in the `ExtensionBinding` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not provide a mask then all fields are overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3126,7 +3126,7 @@ "type": "string" }, "producerExtensionId": { -"description": "Required. Short name of the `ProducerExtension` resource to be created.", +"description": "Required. The short name of the `ProducerExtension` resource to be created.", "location": "query", "type": "string" } @@ -3152,12 +3152,12 @@ ], "parameters": { "etag": { -"description": "Optional. The etag of the ProducerExtension to delete.", +"description": "Optional. The ETag of the `ProducerExtension` to delete.", "location": "query", "type": "string" }, "name": { -"description": "Required. A name of the `ProducerExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", +"description": "Required. The name of the `ProducerExtension` resource to delete. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/producerExtensions/[^/]+$", "required": true, @@ -3182,7 +3182,7 @@ ], "parameters": { "name": { -"description": "Required. A name of the `ProducerExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", +"description": "Required. The name of the `ProducerExtension` resource to get. It must be in this format: `projects/{project}/locations/{location}/producerExtensions/{producer_extension}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/producerExtensions/[^/]+$", "required": true, @@ -3213,12 +3213,12 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The value returned by the last `ListProducerExtensionsResponse` Indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.", +"description": "Optional. The value returned by the last `ListProducerExtensionsResponse`. It indicates that this is a continuation of a prior `ListProducerExtensions` call, and that the system should return the next page of data.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The project and location from which the `ProducerExtension` resources should be listed, specified in the format `projects/{project}/locations/{location}`.", +"description": "Required. The project and location from which the `ProducerExtension` resources should be listed, specified in this format: `projects/{project}/locations/{location}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4132,7 +4132,7 @@ "type": "string" }, "view": { -"description": "Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157).", +"description": "Optional. Determines how much data must be returned in the response. See [AIP-157](https://google.aip.dev/157).", "enum": [ "WASM_PLUGIN_VIEW_UNSPECIFIED", "WASM_PLUGIN_VIEW_BASIC", @@ -4165,13 +4165,13 @@ ], "parameters": { "pageSize": { -"description": "Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. Maximum number of `WasmPlugin` resources to return per call. If not specified, at most 50 `WasmPlugin` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", +"description": "Optional. The value returned by the last `ListWasmPluginsResponse` call. Indicates that this is a continuation of a prior `ListWasmPlugins` call, and that the next page of data is to be returned.", "location": "query", "type": "string" }, @@ -4322,13 +4322,13 @@ ], "parameters": { "pageSize": { -"description": "Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"description": "Optional. Maximum number of `WasmPluginVersion` resources to return per call. If not specified, at most 50 `WasmPluginVersion` resources are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", +"description": "Optional. The value returned by the last `ListWasmPluginVersionsResponse` call. Indicates that this is a continuation of a prior `ListWasmPluginVersions` call, and that the next page of data is to be returned.", "location": "query", "type": "string" }, @@ -4357,7 +4357,7 @@ } } }, -"revision": "20261101", +"revision": "20261109", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AgentConnectivityTemplate": { @@ -4729,7 +4729,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For global AuthzExtension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For regional AuthzExtension, `service` must be a fully-qualified reference to one of the following: * a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * a fully qualified domain name that can be resolved by the Google Cloud DNS. * `iap.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to REQUEST_AUTHZ. * `modelarmor..rep.googleapis.com` and it can only be referenced by an AuthzPolicy with the policyProfile set to CONTENT_AUTHZ.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension: For a global AuthzExtension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. For a regional AuthzExtension, `service` must be a fully qualified reference to one of the following: * A [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`. * A fully qualified domain name that can be resolved by Cloud DNS. * `iap.googleapis.com` and can be referenced only by an `AuthzPolicy` with the `policyProfile` set to `REQUEST_AUTHZ`. * `modelarmor..rep.googleapis.com` and it can only be referenced by an `AuthzPolicy` with the `policyProfile` set to `CONTENT_AUTHZ`.", "type": "string" }, "timeout": { @@ -4767,7 +4767,7 @@ "type": "object" }, "CdnEdgeExtension": { -"description": "`CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices).", +"description": "`CdnEdgeExtension` is a resource that lets the extension service modify the headers of both requests to the cache and responses from the cache served by an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices).", "id": "CdnEdgeExtension", "properties": { "createTime": { @@ -4800,7 +4800,7 @@ }, "target": { "$ref": "CdnEdgeExtensionTarget", -"description": "Required. Specifies the set of resources to which this extension should be applied to." +"description": "Required. Specifies the set of resources to which this extension will be applied." }, "updateTime": { "description": "Output only. The timestamp when the resource was updated.", @@ -4812,11 +4812,11 @@ "type": "object" }, "CdnEdgeExtensionTarget": { -"description": "Specifies the set of targets to which `CdnEdgeExtension` should be applied to.", +"description": "Specifies the set of targets to which a `CdnEdgeExtension` will be applied.", "id": "CdnEdgeExtensionTarget", "properties": { "resources": { -"description": "Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of [EdgeCacheService](https://cloud.google.com/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`.", +"description": "Required. A list of references to the resources that are targeted by `CdnEdgeExtension`. Types of resources supported: `EdgeCacheService`. The format must be the full resource name of an [`EdgeCacheService`](/media-cdn/docs/reference/rest/v1/projects.locations.edgeCacheServices) in the following format: `//networkservices.googleapis.com/projects/{project}/locations/{location}/edgeCacheServices/{edgeCacheService}`.", "items": { "type": "string" }, @@ -5406,7 +5406,7 @@ "type": "string" }, "failOpen": { -"description": "Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `FALSE`. When set to `TRUE`, failures of the extension are silently ignored.", +"description": "Optional. Determines the behavior of the extension binding when the call to the extension fails or times out. Default value is `false`. When set to `true`, failures of the extension are silently ignored.", "type": "boolean" }, "labels": { @@ -5433,7 +5433,7 @@ "type": "integer" }, "producerExtension": { -"description": "Required. The name of the extension that this binding should attach to target resources. Format: For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`.", +"description": "Required. The name of the extension that this binding should attach to target resources. Format: * For Google-provided extensions, specify the service endpoint, for example `modelarmor.us-central1.rep.googleapis.com`.", "type": "string" }, "producerMetadata": { @@ -5491,7 +5491,7 @@ "type": "string" }, "exact": { -"description": "Optional. The input string must match exactly the string specified here. Examples: * `abc` only matches the value `abc`.", +"description": "Optional. The input string must match exactly the string specified here. Examples: * `abc` matches only the value `abc`.", "type": "string" }, "ignoreCase": { @@ -5519,7 +5519,7 @@ }, "notDestination": { "$ref": "ExtensionBindingMatchConditionToDestination", -"description": "Optional. Describes the negated properties of the request destination. Extension will not be invoked on requests that match the criteria specified in this field. At least one of destination or not_destination must be specified." +"description": "Optional. Describes the negated properties of the request destination. The extension will not be invoked on requests that match the criteria specified in this field. At least one of `destination` or `not_destination` must be specified." } }, "type": "object" @@ -5533,21 +5533,21 @@ "description": "Optional. A set of HTTP headers to match against. If not specified, requests with any headers are matched." }, "hosts": { -"description": "Optional. A list of HTTP Hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request.", +"description": "Optional. A list of HTTP hosts to match against. Limited to 10 hosts. If not specified, any host is allowed. If specified, a match occurs if any of the hosts matches the host value in the request.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, "type": "array" }, "paths": { -"description": "Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", +"description": "Optional. A list of paths to match against. Limited to 10 paths. If not specified, any path is allowed. Note that this path match includes the query parameters. For gRPC services, this should be a fully qualified name of the form `/package.service/method`.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, "type": "array" }, "resources": { -"description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (e.g., an Agent in AiApplication). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the AgentRegistry, use the URNs of the registry resources.", +"description": "Optional. A list of non-empty strings whose value is matched against the resource to which a request is sent (for example, an `Agent` in `AiApplication`). If not specified, any resource is allowed. If specified, a match occurs if any of the resources matches the resource value in the request. Limited to 5 resources. When matching against resources in the Agent Registry, use the URNs of the registry resources.", "items": { "$ref": "ExtensionBindingMatchConditionStringMatch" }, @@ -5621,7 +5621,7 @@ "id": "ExtensionChain", "properties": { "extensions": { -"description": "Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` and `CdnEdgeExtension` resources. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to 1 extension per extension chain.", +"description": "Required. A set of extensions to run for the matching request. Up to three extensions can be defined for each extension chain for the `LbTrafficExtension` resource. You can define a maximum of two extensions for each extension chain for the `CdnEdgeExtension` resource. `LbRouteExtension`, `LbEdgeExtension`, and `LbTcpExtension` chains are limited to one extension per extension chain.", "items": { "$ref": "ExtensionChainExtension" }, @@ -5713,7 +5713,7 @@ "type": "string" }, "service": { -"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully-qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Plugin extensions are currently supported for the `LbTrafficExtension`, the `LbRouteExtension`, the `LbEdgeExtension`, and the `CdnEdgeExtension` resources.", +"description": "Required. The reference to the service that runs the extension. To configure a callout extension, `service` must be a fully qualified reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices) in the format: `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}` or `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`. To configure a plugin extension, `service` must be a reference to a [`WasmPlugin` resource](https://cloud.google.com/service-extensions/docs/reference/rest/v1beta1/projects.locations.wasmPlugins) in the format: `projects/{project}/locations/{location}/wasmPlugins/{plugin}` or `//networkservices.googleapis.com/projects/{project}/locations/{location}/wasmPlugins/{wasmPlugin}`. Supports plugin extensions for `LbTrafficExtension`, `LbRouteExtension`, `LbEdgeExtension`, and `CdnEdgeExtension` resources.", "type": "string" }, "supportedEvents": { @@ -5734,8 +5734,8 @@ "If included in `supported_events`, the extension is called when the HTTP request body arrives.", "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", "If included in `supported_events`, the extension is called when the HTTP response body arrives.", -"If included in `supported_events`, the extension is called when the HTTP request trailers arrives.", -"If included in `supported_events`, the extension is called when the HTTP response trailers arrives." +"If included in `supported_events`, the extension is called when the HTTP request trailers arrive.", +"If included in `supported_events`, the extension is called when the HTTP response trailers arrive." ], "type": "string" }, @@ -7133,7 +7133,7 @@ "type": "object" }, "ListCdnEdgeExtensionsResponse": { -"description": "Message for response to listing `CdnEdgeExtension` resources.", +"description": "Contains the response from listing `CdnEdgeExtension` resources.", "id": "ListCdnEdgeExtensionsResponse", "properties": { "cdnEdgeExtensions": { @@ -7794,6 +7794,59 @@ }, "type": "object" }, +"LoggingConfiguration": { +"description": "Configuration for logging collection.", +"id": "LoggingConfiguration", +"properties": { +"enable": { +"description": "Optional. Indicates whether logging is enabled or disabled. Set to true to explicitly enable, or false to explicitly disable.", +"type": "boolean" +}, +"loggingHttpRequestHeaders": { +"description": "Optional. The list of HTTP request headers to be logged. This field can only be specified if logging is enabled.", +"items": { +"type": "string" +}, +"type": "array" +}, +"loggingHttpResponseHeaders": { +"description": "Optional. The list of HTTP response headers to be logged. This field can only be specified if logging is enabled.", +"items": { +"type": "string" +}, +"type": "array" +}, +"optionalFields": { +"description": "Optional. Contains a list of optional fields to include in the logs. This field can only be specified if logging is enabled and `optional_mode` is set to `CUSTOM`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"optionalMode": { +"description": "Optional. Configures whether all, none, or a subset of optional fields should be added to the reported logs. This field can only be specified if logging is enabled.", +"enum": [ +"OPTIONAL_MODE_UNSPECIFIED", +"INCLUDE_ALL_OPTIONAL", +"EXCLUDE_ALL_OPTIONAL", +"CUSTOM" +], +"enumDescriptions": [ +"Unspecified optional mode.", +"Include all optional fields.", +"Exclude all optional fields.", +"Include a custom subset of optional fields." +], +"type": "string" +}, +"sampleRate": { +"description": "Optional. Specifies the logging sampling rate. The sampling rate is a float number in the interval [0, 1]. This field can only be specified if logging is enabled.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "Mesh": { "description": "Mesh represents a logical configuration grouping for workload to workload communication within a service mesh. Routes that point to mesh dictate how requests are routed within this logical mesh boundary.", "id": "Mesh", @@ -8019,7 +8072,7 @@ "type": "object" }, "ProducerExtension": { -"description": "`ProducerExtension` is a resource representing producer defined configuration for their service extension.", +"description": "`ProducerExtension` is a resource that represents a producer-defined configuration for its service extension.", "id": "ProducerExtension", "properties": { "createTime": { @@ -8033,7 +8086,7 @@ "type": "string" }, "etag": { -"description": "Optional. Etag of the resource. If this is provided, it must match the server's etag. If the provided etag does not match the server's etag, the request will fail with a 409 ABORTED error.", +"description": "Optional. ETag of the resource. If this is provided, it must match the server's ETag. If the provided ETag doesn't match the server's ETag, then the request fails with a `409 ABORTED` error.", "type": "string" }, "extensionSettings": { @@ -8052,7 +8105,7 @@ "type": "string" }, "phase": { -"description": "Required. The phase in which this `ProducerExtension` should execute.", +"description": "Required. The phase in which this `ProducerExtension` runs.", "enum": [ "PHASE_UNSPECIFIED", "TRAFFIC", @@ -8060,7 +8113,7 @@ ], "enumDescriptions": [ "Unspecified phase.", -"The `ProducerExtension` will be executed during the traffic phase.", +"Not supported.", "The `ProducerExtension` will be executed during the authorization phase." ], "type": "string" @@ -8087,7 +8140,7 @@ "type": "boolean" }, "service": { -"description": "Required. URI of the PSC attachment.", +"description": "Required. The URI of the Private Service Connect (PSC) attachment.", "type": "string" }, "supportedEvents": { @@ -8108,8 +8161,8 @@ "If included in `supported_events`, the extension is called when the HTTP request body arrives.", "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", "If included in `supported_events`, the extension is called when the HTTP response body arrives.", -"If included in `supported_events`, the extension is called when the HTTP request trailers arrives.", -"If included in `supported_events`, the extension is called when the HTTP response trailers arrives." +"If included in `supported_events`, the extension is called when the HTTP request trailers arrive.", +"If included in `supported_events`, the extension is called when the HTTP response trailers arrive." ], "type": "string" }, @@ -8490,6 +8543,10 @@ "description": "Optional. Set of label tags associated with the TelemetryPolicy resource.", "type": "object" }, +"loggingConfiguration": { +"$ref": "LoggingConfiguration", +"description": "Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how logging will be applied to the target resources." +}, "metricsConfiguration": { "$ref": "MetricsConfiguration", "description": "Optional. Specifies the top-level configuration block within the telemetry policy that contains all the settings for how metrics will be applied to the target resources." diff --git a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json index abcb487797..c7c53bceae 100644 --- a/googleapiclient/discovery_cache/documents/oracledatabase.v1.json +++ b/googleapiclient/discovery_cache/documents/oracledatabase.v1.json @@ -3822,6 +3822,45 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates the `labels` of a single ODB DNS Zone.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/odbNetworks/{odbNetworksId}/odbDnsZones/{odbDnsZonesId}", +"httpMethod": "PATCH", +"id": "oracledatabase.projects.locations.odbNetworks.odbDnsZones.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The name of the OdbDnsZone resource in the following format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbDnsZones/{odb_dns_zone}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/odbNetworks/[^/]+/odbDnsZones/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Optional. A mask specifying which fields in the OdbDnsZone should be updated. A field specified in the mask is updated. If a mask isn't provided, the service treats this as an implied field mask equivalent to all fields that are populated (have a non-empty value). To clear or unset a field, the field must be explicitly specified in the `update_mask`.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "OdbDnsZone" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -4212,7 +4251,7 @@ } } }, -"revision": "20261104", +"revision": "20261112", "rootUrl": "https://oracledatabase.googleapis.com/", "schemas": { "AllConnectionStrings": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 21d893233f..91b58e3cf8 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -1061,7 +1061,7 @@ } } }, -"revision": "20260716", +"revision": "20261108", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1098,7 +1098,7 @@ "type": "string" }, "condition": { -"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", +"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index adada176c0..0644163fd9 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -640,7 +640,7 @@ } } }, -"revision": "20260716", +"revision": "20261108", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -677,7 +677,7 @@ "type": "string" }, "condition": { -"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", +"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index 352e0a730f..33ced2ca10 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1197,7 +1197,7 @@ } } }, -"revision": "20260716", +"revision": "20261108", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { @@ -1234,7 +1234,7 @@ "type": "string" }, "condition": { -"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters.", +"description": "A Common Expression Language (CEL) condition which is used in the evaluation of the constraint. For example: `resource.instanceName.matches(\"(production|test)_(.+_)?[\\d]+\")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1,500 characters.", "type": "string" }, "description": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 9a5766134e..2962387a49 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -172,6 +172,23 @@ "parent" ], "parameters": { +"adCategoryTaxonomyOverride": { +"description": "Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.", +"enum": [ +"AD_CATEGORY_TAXONOMY_UNSPECIFIED", +"GOOGLE_AD_CATEGORY_TAXONOMY", +"IAB_CONTENT_1_0", +"IAB_CONTENT_2_2" +], +"enumDescriptions": [ +"Default value that should never be used.", +"Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data", +"IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.", +"IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details." +], +"location": "query", +"type": "string" +}, "filter": { "description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'", "location": "query", @@ -1005,6 +1022,23 @@ "name" ], "parameters": { +"adCategoryTaxonomyOverride": { +"description": "Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.", +"enum": [ +"AD_CATEGORY_TAXONOMY_UNSPECIFIED", +"GOOGLE_AD_CATEGORY_TAXONOMY", +"IAB_CONTENT_1_0", +"IAB_CONTENT_2_2" +], +"enumDescriptions": [ +"Default value that should never be used.", +"Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data", +"IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.", +"IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. Name of the creative to retrieve. See creative.name.", "location": "path", @@ -1045,6 +1079,23 @@ "parent" ], "parameters": { +"adCategoryTaxonomyOverride": { +"description": "Optional. The category taxonomy to use for the response. Overrides the default category taxonomy for the bidder.", +"enum": [ +"AD_CATEGORY_TAXONOMY_UNSPECIFIED", +"GOOGLE_AD_CATEGORY_TAXONOMY", +"IAB_CONTENT_1_0", +"IAB_CONTENT_2_2" +], +"enumDescriptions": [ +"Default value that should never be used.", +"Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data", +"IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.", +"IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details." +], +"location": "query", +"type": "string" +}, "filter": { "description": "Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'", "location": "query", @@ -1333,7 +1384,7 @@ } } }, -"revision": "20260929", +"revision": "20261111", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2026,12 +2077,14 @@ "enum": [ "AD_CATEGORY_TAXONOMY_UNSPECIFIED", "GOOGLE_AD_CATEGORY_TAXONOMY", -"IAB_CONTENT_1_0" +"IAB_CONTENT_1_0", +"IAB_CONTENT_2_2" ], "enumDescriptions": [ "Default value that should never be used.", "Google ad categories taxonomy, including product categories and sensitive categories. Find the category lists at https://developers.google.com/authorized-buyers/rtb/data#reference-data", -"IAB Content Taxonomy 1.0. See https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv for more details." +"IAB Content Taxonomy 1.0. See [Content Taxonomy 1.0.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%201.0.tsv) for more details.", +"IAB Content Taxonomy 2.2. See [Content Taxonomy 2.2.tsv](https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv) for more details." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index b0a59101a7..9255e98e6d 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3652,7 +3652,7 @@ } } }, -"revision": "20261031", +"revision": "20261108", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4201,11 +4201,11 @@ "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), `Memory`, or `Disk`. 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`. For more information, see the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes#emptydir).", "type": "string" }, "sizeLimit": { -"description": "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", +"description": "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).", "type": "string" } }, @@ -4473,17 +4473,6 @@ }, "type": "object" }, -"FilestoreVolumeSource": { -"description": "Represents a volume backed by a Filestore instance.", -"id": "FilestoreVolumeSource", -"properties": { -"volume": { -"description": "Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`", -"type": "string" -} -}, -"type": "object" -}, "GRPCAction": { "description": "GRPCAction describes an action involving a GRPC port.", "id": "GRPCAction", @@ -5042,7 +5031,8 @@ false "type": "string" }, "rankedMachineSeries": { -"description": "Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM.", +"deprecated": true, +"description": "Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect.", "items": { "enum": [ "MACHINE_SERIES_UNSPECIFIED", @@ -8217,10 +8207,6 @@ false "$ref": "EmptyDirVolumeSource", "description": "Ephemeral storage used as a shared volume." }, -"filestore": { -"$ref": "FilestoreVolumeSource", -"description": "Represents a volume backed by a Filestore instance." -}, "name": { "description": "Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 9884560675..3ef820bcd3 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1052,7 +1052,7 @@ ] }, "testIamPermissions": { -"description": "Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.", +"description": "Returns permissions that a caller has on the specified Instance. There are no permissions required for making this API call.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:testIamPermissions", "httpMethod": "POST", "id": "run.projects.locations.instances.testIamPermissions", @@ -2669,7 +2669,7 @@ } } }, -"revision": "20261031", +"revision": "20261108", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2AmbientNetworking": { @@ -2775,6 +2775,13 @@ "$ref": "GoogleCloudRunV2BuildConfigurationDockerBuild", "description": "Optional. Builds the source using Docker." }, +"environmentVariables": { +"description": "Optional. Environment variables for the build.", +"items": { +"$ref": "GoogleCloudRunV2EnvVar" +}, +"type": "array" +}, "imageRepositoryUri": { "description": "Required. Artifact Registry URI to store the built image.", "type": "string" @@ -2813,7 +2820,8 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Environment variables for the build.", +"deprecated": true, +"description": "Optional. Deprecated: Use environment_variables in BuildConfiguration instead.", "type": "object" } }, @@ -3013,12 +3021,14 @@ "type": "string" }, "lastTransitionTime": { -"description": "Last time the condition transitioned from one status to another.", +"description": "Output only. Last time the condition transitioned from one status to another.", "format": "google-datetime", +"readOnly": true, "type": "string" }, "message": { -"description": "Human readable message indicating details about the current status.", +"description": "Output only. Human readable message indicating details about the current status.", +"readOnly": true, "type": "string" }, "reason": { @@ -3098,7 +3108,7 @@ "type": "string" }, "severity": { -"description": "How to interpret failures of this condition, one of Error, Warning, Info", +"description": "Output only. How to interpret failures of this condition, one of Error, Warning, Info", "enum": [ "SEVERITY_UNSPECIFIED", "ERROR", @@ -3111,10 +3121,11 @@ "Warning severity.", "Info severity." ], +"readOnly": true, "type": "string" }, "state": { -"description": "State of the condition.", +"description": "Output only. State of the condition.", "enum": [ "STATE_UNSPECIFIED", "CONDITION_PENDING", @@ -3129,10 +3140,12 @@ "Terminal state: Reconciliation did not succeed.", "Terminal state: Reconciliation completed successfully." ], +"readOnly": true, "type": "string" }, "type": { -"description": "type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * \"Ready\": True when the Resource is ready.", +"description": "Output only. type is used to communicate the status of the reconciliation process. See also: https://github.com/knative/serving/blob/main/docs/spec/errors.md#error-conditions-and-reporting Types common to all resources include: * \"Ready\": True when the Resource is ready.", +"readOnly": true, "type": "string" } }, @@ -3301,6 +3314,18 @@ }, "type": "object" }, +"GoogleCloudRunV2CpuScaling": { +"description": "Represents CPU-related scaling settings.", +"id": "GoogleCloudRunV2CpuScaling", +"properties": { +"cpuUtilization": { +"description": "Optional. Determines a threshold for CPU utilization before scaling begins. Accepted values are between `0.1` and `0.90` (inclusive) or `0.0` to disable CPU utilization as threshold for scaling.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudRunV2DockerBuild": { "description": "Build the source using Docker. This means the source has a Dockerfile.", "id": "GoogleCloudRunV2DockerBuild", @@ -3308,11 +3333,11 @@ "type": "object" }, "GoogleCloudRunV2EmptyDirVolumeSource": { -"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": "Represents in-memory (tmpfs) 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": "GoogleCloudRunV2EmptyDirVolumeSource", "properties": { "medium": { -"description": "The medium on which the data is stored. Acceptable values today is only MEMORY or none. When none, the default will currently be backed by memory but could change over time. +optional", +"description": "The medium on which the data is stored. Acceptable values are `MEMORY`, `DISK`, or unset (`MEDIUM_UNSPECIFIED`). When unset, the default is currently memory-backed but could change over time.", "enum": [ "MEDIUM_UNSPECIFIED", "MEMORY", @@ -3326,7 +3351,7 @@ "type": "string" }, "sizeLimit": { -"description": "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", +"description": "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. For more information, see [Configure in-memory volume mounts](https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume) and the [Kubernetes `emptyDir` volume documentation](https://kubernetes.io/docs/concepts/storage/volumes/#emptydir).", "type": "string" } }, @@ -3710,17 +3735,6 @@ }, "type": "object" }, -"GoogleCloudRunV2FilestoreVolumeSource": { -"description": "Represents a volume backed by a Filestore instance.", -"id": "GoogleCloudRunV2FilestoreVolumeSource", -"properties": { -"volume": { -"description": "Required. The resource name of the Filestore volume. Format: `projects/{project}/locations/{location}/volumePools/{volume_pool}/volumes/{volume}`", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudRunV2GCSVolumeSource": { "description": "Represents a volume backed by a Cloud Storage bucket (mounted via Cloud Storage FUSE or as a block device disk).", "id": "GoogleCloudRunV2GCSVolumeSource", @@ -6126,10 +6140,6 @@ "$ref": "GoogleCloudRunV2EmptyDirVolumeSource", "description": "Ephemeral storage used as a shared volume." }, -"filestore": { -"$ref": "GoogleCloudRunV2FilestoreVolumeSource", -"description": "Optional. Represents a volume backed by a Filestore instance." -}, "gcs": { "$ref": "GoogleCloudRunV2GCSVolumeSource", "description": "Persistent storage backed by a Google Cloud Storage bucket." @@ -6498,10 +6508,38 @@ "description": "Worker pool scaling settings.", "id": "GoogleCloudRunV2WorkerPoolScaling", "properties": { +"cpuScaling": { +"$ref": "GoogleCloudRunV2CpuScaling", +"description": "Optional. The CPU scaling settings for the worker pool." +}, "manualInstanceCount": { "description": "Optional. The total number of instances in manual scaling mode.", "format": "int32", "type": "integer" +}, +"maxInstanceCount": { +"description": "Optional. The maximum count of instances distributed among revisions based on the specified instance split percentages.", +"format": "int32", +"type": "integer" +}, +"minInstanceCount": { +"description": "Optional. The minimum count of instances distributed among revisions based on the specified instance split percentages.", +"format": "int32", +"type": "integer" +}, +"scalingMode": { +"description": "Optional. The scaling mode for the worker pool.", +"enum": [ +"SCALING_MODE_UNSPECIFIED", +"AUTOMATIC", +"MANUAL" +], +"enumDescriptions": [ +"Unspecified.", +"Automatically scale between min and max instances.", +"Scale to manual instance count." +], +"type": "string" } }, "type": "object" @@ -7045,7 +7083,8 @@ false "type": "string" }, "rankedMachineSeries": { -"description": "Optional. Ranked list (earlier items have higher priority) of Machine Series to consider when provisioning Worker VMs. A concrete machine type will be selected based on machine availability in the given region. This field must be empty for the Build to be eligible to be paired with a pre-provisioned worker VM.", +"deprecated": true, +"description": "Optional. Deprecated: Use PrivatePoolV1Config.WorkerConfig.ranked_machine_series instead. This field has no effect.", "items": { "enum": [ "MACHINE_SERIES_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 18ee5cd381..da335d9ecb 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20260805", +"revision": "20261115", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { @@ -587,14 +587,16 @@ "PAGE", "COUNTRY", "DEVICE", -"SEARCH_APPEARANCE" +"SEARCH_APPEARANCE", +"BRANDED_CLASSIFICATION" ], "enumDescriptions": [ "", "", "", "", -"" +"", +"Filters by branded query classification (`BRANDED` or `NON_BRANDED`)." ], "type": "string" }, @@ -627,8 +629,15 @@ "description": "A set of `dimension` value filters to test against each row. Only rows that pass all filter groups will be returned. All results within a filter group are either AND'ed or OR'ed together, depending on the group type selected. All filter groups are AND'ed together.", "id": "ApiDimensionFilterGroup", "properties": { +"filterLists": { +"description": "Optional. Unlike the `filters` field which only supports a single value per entry, `filter_lists` allows matching against a list of values for a single dimension in one filter. `filter_lists` supports `COUNTRY` and `DEVICE` dimensions only. The maximum number of `expressions` allowed in a single filter list is 1000.", +"items": { +"$ref": "ApiDimensionFilterList" +}, +"type": "array" +}, "filters": { -"description": "Optional. A list of single-value filters in this group.", +"description": "Optional. A list of single-value filters in this group. A list of multi-value dimension filters. A row matches if its value for the specified dimension matches any of the values in the filter list (implicit OR logic, e.g., `COUNTRY` is `'usa'` OR `'can'`).", "items": { "$ref": "ApiDimensionFilter" }, @@ -647,6 +656,40 @@ }, "type": "object" }, +"ApiDimensionFilterList": { +"description": "A filter that allows specifying multiple values for a single dimension. The matching logic is an implicit OR of equality matches (e.g., `COUNTRY` is `'usa'` OR `'can'`). Only supported for `COUNTRY` and `DEVICE`.", +"id": "ApiDimensionFilterList", +"properties": { +"dimension": { +"description": "Required. The dimension to filter by. Only supported for `COUNTRY` and `DEVICE`.", +"enum": [ +"QUERY", +"PAGE", +"COUNTRY", +"DEVICE", +"SEARCH_APPEARANCE", +"BRANDED_CLASSIFICATION" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"Filters by branded query classification (`BRANDED` or `NON_BRANDED`)." +], +"type": "string" +}, +"expressions": { +"description": "Required. The values to filter against. A row matches if its value for the specified `dimension` equals any of these `expressions` (implicit OR logic between the `expressions`). The maximum number of `expressions` allowed is 1000.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "BlockedResource": { "description": "Blocked resource.", "id": "BlockedResource", @@ -1175,7 +1218,8 @@ "COUNTRY", "DEVICE", "SEARCH_APPEARANCE", -"HOUR" +"HOUR", +"BRANDED_CLASSIFICATION" ], "enumDescriptions": [ "Group by date, which is returned in YYYY-MM-DD format, in PT time (UTC - 7:00/8:00).", @@ -1184,7 +1228,8 @@ "Group by country, specified by 3-letter country code ([ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).", "Group by device type (DESKTOP, MOBILE and TABLET).", "Group by search result feature.", -"Group by hour, which is returned in YYYY-MM-DDThh:mm:ss[+|-]hh:mm format (ISO-8601 extended offset date-time format) in PT time (UTC - 7:00/8:00). Data is available up to 10 days. Requires setting the dataState to HOURLY_ALL." +"Group by hour, which is returned in YYYY-MM-DDThh:mm:ss[+|-]hh:mm format (ISO-8601 extended offset date-time format) in PT time (UTC - 7:00/8:00). Data is available up to 10 days. Requires setting the dataState to HOURLY_ALL.", +"Group by branded query classification (`BRANDED` and `NON_BRANDED`)." ], "type": "string" }, @@ -1207,7 +1252,8 @@ "VIDEO", "NEWS", "DISCOVER", -"GOOGLE_NEWS" +"GOOGLE_NEWS", +"WEB_MULTIMODAL" ], "enumDescriptions": [ "", @@ -1215,7 +1261,8 @@ "", "News tab in search.", "Discover.", -"Google News (news.google.com or mobile app)." +"Google News (news.google.com or mobile app).", +"Web multimodal search." ], "type": "string" }, @@ -1236,7 +1283,8 @@ "VIDEO", "NEWS", "DISCOVER", -"GOOGLE_NEWS" +"GOOGLE_NEWS", +"WEB_MULTIMODAL" ], "enumDescriptions": [ "", @@ -1244,7 +1292,8 @@ "", "News tab in search.", "Discover.", -"Google News (news.google.com or mobile app)." +"Google News (news.google.com or mobile app).", +"Web multimodal search." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 1b82dcd85e..7416fa1da4 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -5766,7 +5766,7 @@ } } }, -"revision": "20261023", +"revision": "20261110", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -13394,6 +13394,52 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2RuntimeInfo": { +"id": "GoogleCloudSecuritycenterV2RuntimeInfo", +"properties": { +"evidence": { +"enum": [ +"RUNTIME_EVIDENCE_UNSPECIFIED", +"VULNERABLE_PACKAGE_NOT_LOADED", +"VULNERABLE_PACKAGE_LOADED", +"VULNERABLE_CLASS_OR_SCRIPT_LOADED", +"VULNERABLE_FUNCTION_EXECUTED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +}, +"firstObservedTime": { +"format": "google-datetime", +"type": "string" +}, +"impact": { +"enum": [ +"RUNTIME_IMPACT_UNSPECIFIED", +"NO_IMPACT", +"POTENTIAL_IMPACT", +"ACTIVE_IMPACT" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"lastObservedTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Secret": { "id": "GoogleCloudSecuritycenterV2Secret", "properties": { @@ -13750,6 +13796,9 @@ false "reachable": { "type": "boolean" }, +"runtimeInfo": { +"$ref": "GoogleCloudSecuritycenterV2RuntimeInfo" +}, "securityBulletin": { "$ref": "GoogleCloudSecuritycenterV2SecurityBulletin" } @@ -15815,6 +15864,52 @@ false "properties": {}, "type": "object" }, +"RuntimeInfo": { +"id": "RuntimeInfo", +"properties": { +"evidence": { +"enum": [ +"RUNTIME_EVIDENCE_UNSPECIFIED", +"VULNERABLE_PACKAGE_NOT_LOADED", +"VULNERABLE_PACKAGE_LOADED", +"VULNERABLE_CLASS_OR_SCRIPT_LOADED", +"VULNERABLE_FUNCTION_EXECUTED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +}, +"firstObservedTime": { +"format": "google-datetime", +"type": "string" +}, +"impact": { +"enum": [ +"RUNTIME_IMPACT_UNSPECIFIED", +"NO_IMPACT", +"POTENTIAL_IMPACT", +"ACTIVE_IMPACT" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"lastObservedTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "Secret": { "id": "Secret", "properties": { @@ -16456,6 +16551,9 @@ false "reachable": { "type": "boolean" }, +"runtimeInfo": { +"$ref": "RuntimeInfo" +}, "securityBulletin": { "$ref": "SecurityBulletin" } diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index 9794b88193..bb19281c04 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -895,7 +895,7 @@ } } }, -"revision": "20261023", +"revision": "20261110", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -8263,6 +8263,52 @@ false }, "type": "object" }, +"GoogleCloudSecuritycenterV2RuntimeInfo": { +"id": "GoogleCloudSecuritycenterV2RuntimeInfo", +"properties": { +"evidence": { +"enum": [ +"RUNTIME_EVIDENCE_UNSPECIFIED", +"VULNERABLE_PACKAGE_NOT_LOADED", +"VULNERABLE_PACKAGE_LOADED", +"VULNERABLE_CLASS_OR_SCRIPT_LOADED", +"VULNERABLE_FUNCTION_EXECUTED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +}, +"firstObservedTime": { +"format": "google-datetime", +"type": "string" +}, +"impact": { +"enum": [ +"RUNTIME_IMPACT_UNSPECIFIED", +"NO_IMPACT", +"POTENTIAL_IMPACT", +"ACTIVE_IMPACT" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"lastObservedTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudSecuritycenterV2Secret": { "id": "GoogleCloudSecuritycenterV2Secret", "properties": { @@ -8619,6 +8665,9 @@ false "reachable": { "type": "boolean" }, +"runtimeInfo": { +"$ref": "GoogleCloudSecuritycenterV2RuntimeInfo" +}, "securityBulletin": { "$ref": "GoogleCloudSecuritycenterV2SecurityBulletin" } @@ -10305,6 +10354,52 @@ false "properties": {}, "type": "object" }, +"RuntimeInfo": { +"id": "RuntimeInfo", +"properties": { +"evidence": { +"enum": [ +"RUNTIME_EVIDENCE_UNSPECIFIED", +"VULNERABLE_PACKAGE_NOT_LOADED", +"VULNERABLE_PACKAGE_LOADED", +"VULNERABLE_CLASS_OR_SCRIPT_LOADED", +"VULNERABLE_FUNCTION_EXECUTED" +], +"enumDescriptions": [ +"", +"", +"", +"", +"" +], +"type": "string" +}, +"firstObservedTime": { +"format": "google-datetime", +"type": "string" +}, +"impact": { +"enum": [ +"RUNTIME_IMPACT_UNSPECIFIED", +"NO_IMPACT", +"POTENTIAL_IMPACT", +"ACTIVE_IMPACT" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"lastObservedTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "Secret": { "id": "Secret", "properties": { @@ -10743,6 +10838,9 @@ false "reachable": { "type": "boolean" }, +"runtimeInfo": { +"$ref": "RuntimeInfo" +}, "securityBulletin": { "$ref": "SecurityBulletin" } diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index f80c581037..cb89c75e80 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260721", +"revision": "20261110", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1100,7 +1100,8 @@ "id": "CommonLanguageSettings", "properties": { "destinations": { -"description": "The destination where API teams want this client library to be published.", +"deprecated": true, +"description": "Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published.", "items": { "enum": [ "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 428dfc94fa..15e2c2035e 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -724,7 +724,7 @@ } } }, -"revision": "20260721", +"revision": "20261110", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1211,7 +1211,8 @@ "id": "CommonLanguageSettings", "properties": { "destinations": { -"description": "The destination where API teams want this client library to be published.", +"deprecated": true, +"description": "Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published.", "items": { "enum": [ "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index ad87c6b606..082b1c9c0a 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -835,7 +835,7 @@ } } }, -"revision": "20260731", +"revision": "20261109", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1417,7 +1417,8 @@ "id": "CommonLanguageSettings", "properties": { "destinations": { -"description": "The destination where API teams want this client library to be published.", +"deprecated": true, +"description": "Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published.", "items": { "enum": [ "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED", @@ -2212,6 +2213,38 @@ }, "type": "object" }, +"GoogleApiFieldInfo": { +"description": "Rich semantic information of an API field beyond basic typing.", +"id": "GoogleApiFieldInfo", +"properties": { +"format": { +"description": "The standard format of a field value. This does not explicitly configure any API consumer, just documents the API's format for the field it is applied to.", +"enum": [ +"FORMAT_UNSPECIFIED", +"UUID4", +"IPV4", +"IPV6", +"IPV4_OR_IPV6" +], +"enumDescriptions": [ +"Default, unspecified value.", +"Universally Unique Identifier, version 4, value as defined by https://datatracker.ietf.org/doc/html/rfc4122. The value may be normalized to entirely lowercase letters. For example, the value `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to `f47ac10b-58cc-0372-8567-0e02b2c3d479`.", +"Internet Protocol v4 value as defined by [RFC 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be condensed, with leading zeros in each octet stripped. For example, `001.022.233.040` would be condensed to `1.22.233.40`.", +"Internet Protocol v6 value as defined by [RFC 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be normalized to entirely lowercase letters with zeros compressed, following [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example, the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.", +"An IP address in either v4 or v6 format as described by the individual values defined herein. See the comments on the IPV4 and IPV6 types for allowed normalizations of each." +], +"type": "string" +}, +"referencedTypes": { +"description": "The type(s) that the annotated, generic field may represent. Currently, this must only be used on fields of type `google.protobuf.Any`. Supporting other generic types may be considered in the future.", +"items": { +"$ref": "TypeReference" +}, +"type": "array" +} +}, +"type": "object" +}, "Http": { "description": "Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.", "id": "Http", @@ -3851,6 +3884,17 @@ }, "type": "object" }, +"TypeReference": { +"description": "A reference to a message type, for use in FieldInfo.", +"id": "TypeReference", +"properties": { +"typeName": { +"description": "The name of the type that the annotated, generic field may represent. If the type is in the same protobuf package, the value can be the simple message name e.g., `\"MyMessage\"`. Otherwise, the value must be the fully-qualified message name e.g., `\"google.library.v1.Book\"`. If the type(s) are unknown to the service (e.g. the field accepts generic user input), use the wildcard `\"*\"` to denote this behavior. See [AIP-202](https://google.aip.dev/202#type-references) for more details.", +"type": "string" +} +}, +"type": "object" +}, "UndeleteServiceResponse": { "description": "Response message for UndeleteService method.", "id": "UndeleteServiceResponse", diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 83ad49d408..8ef086b3f5 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -431,7 +431,7 @@ } } }, -"revision": "20260921", +"revision": "20261110", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1137,7 +1137,8 @@ "id": "CommonLanguageSettings", "properties": { "destinations": { -"description": "The destination where API teams want this client library to be published.", +"deprecated": true, +"description": "Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published.", "items": { "enum": [ "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 22f4febcce..f113643408 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -969,7 +969,7 @@ } } }, -"revision": "20260921", +"revision": "20261110", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1655,7 +1655,8 @@ "id": "CommonLanguageSettings", "properties": { "destinations": { -"description": "The destination where API teams want this client library to be published.", +"deprecated": true, +"description": "Deprecated: Client libraries are published for all supported languages by default when a `library_settings` entry is present with a `version` and `launch_stage`. The destination where API teams want this client library to be published.", "items": { "enum": [ "CLIENT_LIBRARY_DESTINATION_UNSPECIFIED", @@ -1752,20 +1753,6 @@ }, "type": "array" }, -"trafficSource": { -"description": "Indicates the traffic type attribution for this quota limit (e.g. agentic). This is an informational field used to categorize and filter the quota limits.", -"enum": [ -"TRAFFIC_SOURCE_UNSPECIFIED", -"TRAFFIC_SOURCE_NONAGENTIC", -"TRAFFIC_SOURCE_AGENTIC" -], -"enumDescriptions": [ -"This quota limit applies to all traffic. This is the default value.", -"This quota limit applies to traffic not recognized as agentic.", -"This quota limit applies to only agentic traffic." -], -"type": "string" -}, "unit": { "description": "The limit unit. An example unit would be `1/{project}/{region}` Note that `{project}` and `{region}` are not placeholders in this example; the literal characters `{` and `}` occur in the string.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 3f4b930eaa..ae0aa1da7a 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -892,7 +892,7 @@ } } }, -"revision": "20261019", +"revision": "20261109", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -1473,7 +1473,7 @@ }, "lineStyle": { "$ref": "LineStyle", -"description": "The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA or LINE." +"description": "The line style of this series. Valid only if the chartType is AREA, LINE, or SCATTER. COMBO charts are also supported if the series chart type is AREA, STEPPED_AREA, or LINE." }, "pointStyle": { "$ref": "PointStyle", @@ -1507,7 +1507,7 @@ "type": "string" }, "type": { -"description": "The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, and COLUMN are supported.", +"description": "The type of this series. Valid only if the chartType is COMBO. Different types will change the way the series is visualized. Only LINE, AREA, STEPPED_AREA, and COLUMN are supported.", "enum": [ "BASIC_CHART_TYPE_UNSPECIFIED", "BAR", @@ -1619,7 +1619,7 @@ "type": "string" }, "lineSmoothing": { -"description": "Gets whether all lines should be rendered smooth or straight by default. Applies to Line charts.", +"description": "Gets whether all lines should be rendered smooth or straight by default. Applies to Line and Combo charts.", "type": "boolean" }, "series": { diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index d5869bb1b3..82555470cf 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": "\"3130373737383931373330383137363536363734\"", +"etag": "\"3133333534363036353333363239373332313233\"", "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" @@ -456,40 +456,8 @@ "https://www.googleapis.com/auth/devstorage.read_write" ] }, -"pause": { -"description": "Pauses an Anywhere Cache instance.", -"httpMethod": "POST", -"id": "storage.anywhereCaches.pause", -"parameterOrder": [ -"bucket", -"anywhereCacheId" -], -"parameters": { -"anywhereCacheId": { -"description": "The ID of requested Anywhere Cache instance.", -"location": "path", -"required": true, -"type": "string" -}, -"bucket": { -"description": "Name of the parent bucket.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "b/{bucket}/anywhereCaches/{anywhereCacheId}/pause", -"response": { -"$ref": "AnywhereCache" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/devstorage.full_control", -"https://www.googleapis.com/auth/devstorage.read_write" -] -}, "resume": { -"description": "Resumes a paused or disabled Anywhere Cache instance.", +"description": "Resumes a disabled Anywhere Cache instance.", "httpMethod": "POST", "id": "storage.anywhereCaches.resume", "parameterOrder": [ @@ -4761,7 +4729,7 @@ } } }, -"revision": "20261009", +"revision": "20261111", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -5608,6 +5576,16 @@ "locationType": { "description": "The type of the bucket location.", "type": "string" +}, +"rapidCacheInfo": { +"description": "The Rapid Cache configuration for the bucket.", +"properties": { +"cacheType": { +"description": "The type of cache in the bucket. Set to `rapid-cache` or `rapid-cache-ultra`, only if there is a cache present.", +"type": "string" +} +}, +"type": "object" } }, "type": "object" @@ -6401,6 +6379,19 @@ "description": "The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration.", "format": "date-time", "type": "string" +}, +"zonalAvailabilityInfo": { +"description": "Information about the object's availability in Rapid Cache Ultra (RCU) zonal caches. This field will only populate once the object is loaded into the cache.", +"properties": { +"availableZones": { +"description": "A list of zones where the object has a zonal copy. The zone names are expected to be in lower-dash case format (e.g., 'us-central1-a').", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 53e9f2b2e2..f62aa3c6fd 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -470,7 +470,7 @@ ], "parameters": { "destinationTasklist": { -"description": "Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list. Recurrent tasks cannot currently be moved between lists.", +"description": "Optional. Destination task list identifier. If set, the task is moved from tasklist to the destinationTasklist list. Otherwise the task is moved within its current list.", "location": "query", "type": "string" }, @@ -576,7 +576,7 @@ } } }, -"revision": "20261101", +"revision": "20261110", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "AssignmentInfo": { diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index c704adae66..057a72968a 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2731,7 +2731,7 @@ } } }, -"revision": "20260806", +"revision": "20261111", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -3962,7 +3962,7 @@ true "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "kind": { @@ -3976,7 +3976,7 @@ true }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "locations": { "deprecated": true, @@ -4783,7 +4783,7 @@ true "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "kind": { @@ -4825,7 +4825,7 @@ true }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "locations": { "deprecated": true, @@ -5763,7 +5763,7 @@ true "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "kind": { @@ -5785,7 +5785,7 @@ true }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "localizedMerchantName": { "$ref": "LocalizedString", @@ -6666,7 +6666,7 @@ true "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "kind": { @@ -6688,7 +6688,7 @@ true }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "localizedProgramName": { "$ref": "LocalizedString", @@ -7693,7 +7693,7 @@ false "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "kind": { @@ -7715,7 +7715,7 @@ false }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "localizedProvider": { "$ref": "LocalizedString", @@ -9164,7 +9164,7 @@ true "description": "Deprecated. Use textModulesData instead." }, "issuerName": { -"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens.", +"description": "Required. The issuer name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. Ignored if `localizedIssuerName` is set, including when a patch request sets only this field. To change the issuer name of a class that has `localizedIssuerName`, update `localizedIssuerName` instead.", "type": "string" }, "languageOverride": { @@ -9177,7 +9177,7 @@ true }, "localizedIssuerName": { "$ref": "LocalizedString", -"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens." +"description": "Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. If set, this field takes precedence over `issuerName`." }, "locations": { "deprecated": true, diff --git a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json index f1d110e788..7254c03767 100644 --- a/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json +++ b/googleapiclient/discovery_cache/documents/webcontentpublisher.v1.json @@ -514,7 +514,7 @@ } } }, -"revision": "20261103", +"revision": "20261111", "rootUrl": "https://webcontentpublisher.googleapis.com/", "schemas": { "AnswerChoiceTemplate": { @@ -1634,7 +1634,7 @@ false "id": "Cta", "properties": { "displayName": { -"description": "Required. The user-visible display name of the CTA.", +"description": "Optional. The user-visible display name of the CTA (up to 40 characters). Defaults to a server-specified name based on the CTA type when omitted on creation.", "type": "string" }, "name": { @@ -1707,7 +1707,7 @@ false "type": "string" }, "displayText": { -"description": "Optional. The question prompt displayed to readers (up to 140 characters).", +"description": "Required. The question prompt displayed to readers (up to 140 characters).", "type": "string" }, "id": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 3bb9f914b3..6520ed3c12 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1291,7 +1291,7 @@ } } }, -"revision": "20260923", +"revision": "20261108", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1563,6 +1563,16 @@ "format": "int32", "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 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.", +"format": "int64", +"type": "string" +}, "reclaimPolicy": { "description": "Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.", "enum": [ @@ -2518,6 +2528,10 @@ "readOnly": true, "type": "array" }, +"consoleBaseUrl": { +"description": "Optional. Specifies a custom base URL for the Google Cloud Console. This field is intended to be user-configurable to support data residency for Cloud Workstations users. This will be used generally for user journeys where users need to go to the Cloud Console from Code OSS. When the Auth and Launch URLs are unset, this will be used as the base URL for those endpoints if set.", +"type": "string" +}, "controlPlaneIp": { "description": "Output only. The private IP address of the control plane for this workstation cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address.", "readOnly": true,